diff --git a/README.md b/README.md index 16cca89..2bf067d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Example Pyth Publisher -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.** +An example publisher demonstrating how to use the [Pyth Agent websocket API](https://docs.pyth.network/price-feeds/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. @@ -7,15 +7,17 @@ The publisher: - Publishes price updates for those symbols in response to `notify_price_sched` messages from Pyth Agent. ## Prerequisites -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`). +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://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). +An example configuration file can be found in [`config/config.toml`](config/config.toml). The format of the configuration file is documented [here](example_publisher/config.py). ## Run + +[Poetry](https://python-poetry.org/docs/) is used to manage the dependencies and run the tests. If you don't have it installed, you can install following the instructions [here](https://python-poetry.org/docs/#installation). + ```bash -# Install poetry if it's not installed, then run the -# following command to install the dependencies. +# Install the dependencies poetry install # Run the tests