Skip to content

docs: refresh stale docs.pyth.network URLs across TS/JS SDK READMEs #3718

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.

Sign up for GitHub

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

Open
0xghost42 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: refresh stale docs.pyth.network URLs across TS/JS SDK READMEs #3718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion apps/hermes/client/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ pnpm turbo --filter @pythnetwork/hermes-client example -- \
Pyth offers a free public endpoint at [https://hermes.pyth.network](https://hermes.pyth.network). However, it is
recommended to obtain a private endpoint from one of the Hermes RPC providers for more reliability. You can find more
information about Hermes RPC providers
[here](https://docs.pyth.network/documentation/pythnet-price-feeds/hermes#public-endpoint).
[here](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes#public-endpoints).
2 changes: 1 addition & 1 deletion apps/hermes/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To set up and run a Hermes node, follow the steps below:

0. **Prerequisites**: Hermes requires a running instance of Pythnet and the Wormhole spy RPC. You can find instructions
for getting a Pythnet RPC instance from a node provider
[here](https://docs.pyth.network/documentation/pythnet-price-feeds/hermes#hermes-node-providers) and instructions
[here](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes#node-providers) and instructions
for running a Wormhole spy RPC instance [here](https://docs.wormhole.com/wormhole/explore-wormhole/spy). We recommend
using [Beacon](https://github.com/pyth-network/beacon), a highly available rewrite for spy, for production purposes.
1. **Install Rust 1.82.0**: If you haven't already, you'll need to install Rust. You can
Expand Down
4 changes: 2 additions & 2 deletions apps/price_pusher/README.md
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 Old documentation URLs remain in non-Markdown source files

Several source code files still contain old docs.pyth.network/documentation/pythnet-price-feeds/ URLs that were not updated by this PR: apps/price_pusher/src/sui/command.ts, target_chains/cosmwasm/examples/cw-contract/src/contract.rs, target_chains/ethereum/sdk/solidity/PythStructs.sol, target_chains/ethereum/sdk/solidity/IPyth.sol, target_chains/aptos/contracts/Move.toml, target_chains/near/receiver/src/lib.rs, and target_chains/near/receiver/src/state.rs. These are in code comments rather than README files, so they may be intentionally out of scope for this PR, but they should be updated in a follow-up to avoid stale documentation references.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ updates.

NOTE: It is recommended to use stable hermes endpoints. If you are running the price pusher for **Aptos Testnet**, **Sui Testnet**, or **Near Testnet**, we recommend you use beta hermes endpoints.

Pyth hosts [public endpoints](https://docs.pyth.network/price-feeds/api-instances-and-providers/hermes) for Hermes; however, it is recommended to get a private endpoint from one of the
Pyth hosts [public endpoints](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes#public-endpoints) for Hermes; however, it is recommended to get a private endpoint from one of the
Hermes RPC providers for more reliability. Please refer to [this
document](https://docs.pyth.network/documentation/pythnet-price-feeds/hermes) for more information.
document](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes) for more information.

To run the price pusher, please run the following commands, replacing the command line arguments as necessary:

Expand Down
2 changes: 1 addition & 1 deletion price_service/client/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ npm run example -- \
Pyth offers a free public endpoint at [https://hermes.pyth.network](https://hermes.pyth.network). However, it is
recommended to obtain a private endpoint from one of the Hermes RPC providers for more reliability. You can find more
information about Hermes RPC providers
[here](https://docs.pyth.network/documentation/pythnet-price-feeds/hermes#public-endpoint).
[here](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes#public-endpoints).
6 changes: 3 additions & 3 deletions target_chains/aptos/sdk/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ $ yarn add @pythnetwork/pyth-aptos-js
## Quickstart

Pyth stores prices off-chain to minimize gas fees, which allows us to offer a wider selection of products and faster update times.
See [On-Demand Updates](https://docs.pyth.network/documentation/pythnet-price-feeds/on-demand) for more information about this approach.
See [Pull Integration on Aptos](https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/aptos) for more information about this approach.
To use Pyth prices on chain,
they must be fetched from a Hermes instance. The `AptosPriceServiceConnection` class can be used to interact with these services,
providing a way to fetch these prices directly in your code. The following example wraps an existing RPC provider and shows how to obtain
Expand Down Expand Up @@ -79,7 +79,7 @@ module example::your_module {
}
```

We strongly recommend reading our guide which explains [how to work with Pyth price feeds](https://docs.pyth.network/documentation/pythnet-price-feeds/best-practices).
We strongly recommend reading our guide which explains [how to work with Pyth price feeds](https://docs.pyth.network/price-feeds/core/best-practices).

### Off-chain prices

Expand Down Expand Up @@ -136,4 +136,4 @@ npm run example-relay -- \

## Hermes endpoints

Please find the list of public Hermes endpoints [here](https://docs.pyth.network/documentation/pythnet-price-feeds/hermes#public-endpoints).
Please find the list of public Hermes endpoints [here](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes#public-endpoints).
4 changes: 2 additions & 2 deletions target_chains/ethereum/sdk/solidity/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This package provides utilities for consuming prices from the [Pyth Network](https://pyth.network/) Oracle using Solidity. Also, it contains [the Pyth Interface ABI](./abis/IPyth.json) that you can use in your libraries
to communicate with the Pyth contract.

It is **strongly recommended** to follow the [consumer best practices](https://docs.pyth.network/documentation/pythnet-price-feeds/best-practices) when consuming Pyth data.
It is **strongly recommended** to follow the [consumer best practices](https://docs.pyth.network/price-feeds/core/best-practices) when consuming Pyth data.

## Installation

Expand Down Expand Up @@ -76,7 +76,7 @@ Pyth prices are published on Pythnet, and relayed to EVM chains using the [Wormh

This signed message can then be submitted to the Pyth contract on the EVM networks along the required update fee for it, which will verify the Wormhole message and update the Pyth contract with the new price.

Please refer to [Pyth On-Demand Updates page](https://docs.pyth.network/documentation/pythnet-price-feeds/on-demand) for more information.
Please refer to [Pull Integration on EVM](https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/evm) for more information.

## Solidity Target Chains

Expand Down
2 changes: 1 addition & 1 deletion target_chains/ethereum/sdk/stylus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This package provides utilities for consuming prices from the [Pyth Network](https://pyth.network/) Oracle in Rust with Stylus. It also includes the [Pyth Interface ABI](./abis/IPyth.json), which can be used in your libraries to interact with the Pyth contract.

It is **strongly recommended** to follow the [consumer best practices](https://docs.pyth.network/documentation/pythnet-price-feeds/best-practices) when consuming data from Pyth.
It is **strongly recommended** to follow the [consumer best practices](https://docs.pyth.network/price-feeds/core/best-practices) when consuming data from Pyth.

## Features

Expand Down
4 changes: 2 additions & 2 deletions target_chains/fuel/sdk/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ yarn add fuels @pythnetwork/hermes-client
```

Pyth stores prices off-chain to minimize gas fees, which allows us to offer a wider selection of products and faster update times.
See [On-Demand Updates](https://docs.pyth.network/documentation/pythnet-price-feeds/on-demand) for more information about this approach.
See [Pull Integration on Fuel](https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/fuel) for more information about this approach.
To use Pyth prices on chain,
they must be fetched from a Hermes instance. The `HermesClient` class from Pyth's `hermes-client` library can be used to interact with Hermes,
providing a way to fetch these prices directly in your code.
Expand All @@ -40,4 +40,4 @@ chain.

For a complete example of how to obtain Pyth prices and submit them to a Fuel network, check out the [usage example](src/examples/usage.ts) in the `src/examples` directory.

We strongly recommend reading our guide which explains [how to work with Pyth price feeds](https://docs.pyth.network/documentation/pythnet-price-feeds/best-practices).
We strongly recommend reading our guide which explains [how to work with Pyth price feeds](https://docs.pyth.network/price-feeds/core/best-practices).
2 changes: 1 addition & 1 deletion target_chains/near/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ near view --network-id mainnet contract-url.near get_price_unsafe '{ "price_iden
You can find more in-depth documentation on the [Pyth Website][pyth website] for a more in-depth guide to
working with Pyth concepts in general in the context of NEAR.

[pyth website]: https://docs.pyth.network/documentation/pythnet-price-feeds/near
[pyth website]: https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/near
4 changes: 2 additions & 2 deletions target_chains/starknet/sdk/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ yarn add starknet @pythnetwork/price-service-client
```

Pyth stores prices off-chain to minimize gas fees, which allows us to offer a wider selection of products and faster update times.
See [On-Demand Updates](https://docs.pyth.network/documentation/pythnet-price-feeds/on-demand) for more information about this approach.
See [Pull Integration on Starknet](https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/starknet) for more information about this approach.
To use Pyth prices on chain,
they must be fetched from a Hermes instance. The `PriceServiceConnection` class from Pyth's `price-service-client` library can be used to interact with Hermes,
providing a way to fetch these prices directly in your code.
Expand Down Expand Up @@ -111,4 +111,4 @@ await provider.waitForTransaction(tx.transaction_hash);
console.log("transaction confirmed:", tx.transaction_hash);
```

We strongly recommend reading our guide which explains [how to work with Pyth price feeds](https://docs.pyth.network/documentation/pythnet-price-feeds/best-practices).
We strongly recommend reading our guide which explains [how to work with Pyth price feeds](https://docs.pyth.network/price-feeds/core/best-practices).
2 changes: 1 addition & 1 deletion target_chains/sui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ This directory contains the Pyth contract for Sui and utilities to deploy and us
- `contracts` folder contains the Pyth contract source code in Move.
- `sdk` folder contains the Pyth javascript SDK for Sui that should be used by dApp developers.

For more information regarding Pyth integration on Sui please refer to our [docs](https://docs.pyth.network/documentation/pythnet-price-feeds/sui).
For more information regarding Pyth integration on Sui please refer to our [docs](https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/sui).
6 changes: 3 additions & 3 deletions target_chains/sui/sdk/js-iota/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ yarn add @pythnetwork/pyth-iota-js
## Quickstart

Pyth stores prices off-chain to minimize gas fees, which allows us to offer a wider selection of products and faster update times.
See [On-Demand Updates](https://docs.pyth.network/documentation/pythnet-price-feeds/on-demand) for more information about this approach.
See [Pull Integration on Iota](https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/iota) for more information about this approach.
Typically, to use Pyth prices on chain,
they must be fetched from an off-chain Hermes instance. The `IotaPriceServiceConnection` class can be used to interact with these services,
providing a way to fetch these prices directly in your code. The following example wraps an existing RPC provider and shows how to obtain
Expand Down Expand Up @@ -67,7 +67,7 @@ const priceUpdateData = await connection.getPriceFeedsUpdateData(priceIds); // s
// It is either injected from browser or instantiated in backend via some private key
const wallet: SignerWithProvider = getWallet();
// Get the state ids of the Pyth and Wormhole contracts from
// https://docs.pyth.network/documentation/pythnet-price-feeds/sui
// https://docs.pyth.network/price-feeds/core/contract-addresses/sui
const wormholeStateId = " 0xFILL_ME";
const pythStateId = "0xFILL_ME";

Expand Down Expand Up @@ -152,4 +152,4 @@ setTimeout(() => {

## Hermes endpoints

You can find the list of Hermes public endpoints [here](https://docs.pyth.network/documentation/pythnet-price-feeds/hermes#public-endpoints).
You can find the list of Hermes public endpoints [here](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes#public-endpoints).
4 changes: 2 additions & 2 deletions target_chains/sui/sdk/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ $ pnpm install
## Quickstart

Pyth stores prices off-chain to minimize gas fees, which allows us to offer a wider selection of products and faster update times.
See [On-Demand Updates](https://docs.pyth.network/documentation/pythnet-price-feeds/on-demand) for more information about this approach.
See [Pull Integration on Sui](https://docs.pyth.network/price-feeds/core/use-real-time-data/pull-integration/sui) for more information about this approach.
Typically, to use Pyth prices on chain,
they must be fetched from an off-chain Hermes instance. The `SuiPriceServiceConnection` class can be used to interact with these services,
providing a way to fetch these prices directly in your code. The following example wraps an existing RPC provider and shows how to obtain
Expand Down Expand Up @@ -149,4 +149,4 @@ eventSource.close();

## Hermes endpoints

You can find the list of Hermes public endpoints [here](https://docs.pyth.network/documentation/pythnet-price-feeds/hermes#public-endpoints).
You can find the list of Hermes public endpoints [here](https://docs.pyth.network/price-feeds/core/api-instances-and-providers/hermes#public-endpoints).