Skip to content

Commit

Permalink
Update README.md (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
ali-bahjati authored Mar 2, 2023
1 parent b665e03 commit 6ec6bc8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Example Pyth Publisher
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.
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.**

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

## Prerequisites
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`).
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`).

## Configure
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).
Expand Down

0 comments on commit 6ec6bc8

Please sign in to comment.