Skip to content

Commit 6ec6bc8

Browse files
authored
Update README.md (#13)
1 parent b665e03 commit 6ec6bc8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Example Pyth Publisher
2-
An example publisher demonstrating how to use the [Pythd websocket API](https://github.com/pyth-network/pyth-client/blob/main/doc/websocket_api.md) to publish prices to Pyth.
2+
An example publisher demonstrating how to use the [Pyth Agent websocket API](https://docs.pyth.network/publish-data/pyth-client-websocket-api) to publish prices to Pyth. **Pyth publishers publish their own first party data to the Pyth network. This example is created solely for demonstration/testing purposes and is not used in production by any publisher.**
33

44
The publisher:
55
- Looks up the price accounts corresponding to the configured symbols from the on-chain program.
6-
- Continually polls CoinGecko for the latest prices for those symbols.
7-
- Publishes price updates for those symbols in response to `notify_price_sched` messages from Pythd.
6+
- Based on the configured provider, subscribes to the feeds on Pythnet, or polls the prices from Coingecko.
7+
- Publishes price updates for those symbols in response to `notify_price_sched` messages from Pyth Agent.
88

99
## Prerequisites
10-
This requires a running instance of the `pythd` binary to be running. To set this up, follow the [pythd getting started docs](https://docs.pyth.network/publish-data). This example publisher's `publisher.pythd.endpoint` configuration value should be set to the pythd websocket endpoint (e.g. `ws://127.0.0.1:8910`).
10+
This requires a running instance of the `pyth-agent` binary to be running. To set this up, follow the instructions in [Pyth Agent repository]([https://docs.pyth.network/publish-data](https://github.com/pyth-network/pyth-agent)). This example publisher's `publisher.pythd.endpoint` configuration value should be set to the pyth-agent websocket endpoint (e.g. `ws://127.0.0.1:8910`).
1111

1212
## Configure
1313
An example configuration file can be found in [`config/config.toml`](config/config.toml). The format of the configuration file is documented [here](publisher/config.py).

0 commit comments

Comments
 (0)