From 04a8b75f8056aec27c42aec0028fd27d4e2a1854 Mon Sep 17 00:00:00 2001 From: Jayant Krishnamurthy Date: Wed, 15 Mar 2023 07:25:01 -0700 Subject: [PATCH] add docs (#690) Co-authored-by: Jayant Krishnamurthy --- target_chains/cosmwasm/pyth-sdk-cw/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/target_chains/cosmwasm/pyth-sdk-cw/README.md b/target_chains/cosmwasm/pyth-sdk-cw/README.md index 66d5c2ac..03de3d47 100644 --- a/target_chains/cosmwasm/pyth-sdk-cw/README.md +++ b/target_chains/cosmwasm/pyth-sdk-cw/README.md @@ -30,6 +30,13 @@ use pyth_sdk_cw::{ .... ``` +This snippet returns a `PriceFeed` struct which exposes methods for reading the current price along with other useful functionality. +See the [Pyth common SDK documentation](https://github.com/pyth-network/pyth-sdk-rs/tree/main/pyth-sdk#pyth-network-common-rust-sdk) for more information +about this struct. +The common SDK also provides methods for combining price feeds in several useful ways. +These methods allow you to derive prices for alternative quote currencies -- for example, to derive the BTC/ETH price from +the BTC/USD and ETH/USD price feeds -- and to price baskets of currencies. + ## Contracts and Price Feeds Pyth is currently available on the following cosmwasm chains: