Skip to content

Commit b00e468

Browse files
authored
Merge pull request #15 from pyth-network/abehjati/update-readme
Update README.md
2 parents 6c2cc0b + e246c39 commit b00e468

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pyth-sdk-solana/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Pyth SDK Solana
22

33
This crate provides utilities for reading price feeds from the [pyth.network](https://pyth.network/) oracle on the Solana network.
4-
The crate includes a library for on-chain programs and an off-chain example program.
4+
The crate includes a library for reading and using Pyth data feeds in Solana both on-chain (Solana programs) and off-chain (clients interacting with Solana blockchain). It also includes multiple off-chain example programs.
55

66
Key features of this library include:
77

@@ -30,6 +30,8 @@ Pyth Network stores its price feeds in a collection of Solana accounts of variou
3030
* Product accounts store metadata about a product, such as its symbol (e.g., "BTC/USD").
3131
* Mapping accounts store a listing of all Pyth accounts
3232

33+
> :warning: This structure is designed for Pyth Oracle internal program. In most of the use cases only Price account is needed.
34+
3335
For more information on the different types of Pyth accounts, see the [account structure documentation](https://docs.pyth.network/how-pyth-works/account-structure).
3436
The pyth.network website also lists the public keys of the accounts (e.g., [Crypto.BTC/USD accounts](https://pyth.network/markets/#Crypto.BTC/USD)).
3537

@@ -106,7 +108,7 @@ This function additionally propagates any uncertainty in the price into uncertai
106108

107109
### Solana Account Structure
108110

109-
> Warning: the Solana account structure is an internal API that is subject to change. Prefer to use `load_price` when possible.
111+
> :warning: The Solana account structure is an internal API that is subject to change. Prefer to use `load_price` when possible.
110112
111113
This library also provides several `load_*` methods that allow users to translate the binary data in each account into an appropriate struct:
112114

@@ -127,7 +129,7 @@ let mapping_account: &MappingAccount = load_mapping_account( &mapping_account_da
127129

128130
### Off-chain example program
129131

130-
The example program prints the product reference data and current price information for Pyth on Solana devnet.
132+
The example [eth_price](examples/eth_price.rs) program prints the product reference data and current price information for Pyth on Solana devnet.
131133
Run the following commands to try this example program:
132134

133135
```
@@ -147,7 +149,7 @@ ema_price ....... 291343470000 x 10^-8
147149
ema_conf ........ 98874533 x 10^-8
148150
```
149151

150-
For an example of using Solana Account structure please run:
152+
For [an example](examples/get_accounts.rs) of using Solana Account structure please run:
151153
```
152154
cargo run --example get_accounts
153155
```

0 commit comments

Comments
 (0)