Rename Price->PriceFeed, PriceConf->Price (#24)

Author: ali-behjati

pyth-sdk-solana/README.md

@@ -56,29 +56,29 @@ For more detailed information, please see the crate documentation.
 To read the price from a price account on-chain, this library provides a `load_price_from_account_info` method that constructs `Price` struct from AccountInfo:
 
 ```rust
-use pyth_sdk_solana::{load_price_from_account_info, Price};
+use pyth_sdk_solana::{load_price_feed_from_account_info, PriceFeed};
 
 let price_account_info: AccountInfo = ...;
-let price: Price = load_price( &price_account_info ).unwrap();
+let price: PriceFeed = load_price_feed_from_account_info( &price_account_info ).unwrap();
 ```
 
 #### Off-chain
 To read the price from a price account off-chain in clients, this library provides a `load_price_from_account` method that constructs `Price` struct from Account:
 
 ```rust
-use pyth_sdk_solana::{load_price_from_account, Price};
+use pyth_sdk_solana::{load_price_feed_from_account, PriceFeed};
 
 let price_key: Pubkey = ...;
 let mut price_account: Account = ...;
-let price: Price = load_price_from_account( &price_key, &mut price_account ).unwrap();
+let price: PriceFeed = load_price_feed_from_account( &price_key, &mut price_account ).unwrap();
 ```
 
 ### Get the current price
 
-Read the current price from a `Price`: 
+Read the current price from a `PriceFeed`:
 
 ```rust
-let current_price: PriceConf = price.get_current_price().unwrap();
+let current_price: Price = price_feed.get_current_price().unwrap();
 println!("price: ({} +- {}) x 10^{}", current_price.price, current_price.conf, current_price.expo);
 ```
 
@@ -92,10 +92,10 @@ Most assets in Pyth are priced in USD.
 Applications can combine two USD prices to price an asset in a different quote currency:
 
 ```rust
-let btc_usd: Price = ...;
-let eth_usd: Price = ...;
+let btc_usd: PriceFeed = ...;
+let eth_usd: PriceFeed = ...;
 // -8 is the desired exponent for the result 
-let btc_eth: PriceConf = btc_usd.get_price_in_quote(&eth_usd, -8);
+let btc_eth: Price = btc_usd.get_price_in_quote(&eth_usd, -8);
 println!("BTC/ETH price: ({} +- {}) x 10^{}", price.price, price.conf, price.expo);
 ```
 
@@ -104,12 +104,12 @@ println!("BTC/ETH price: ({} +- {}) x 10^{}", price.price, price.conf, price.exp
 Applications can also compute the value of a basket of multiple assets:
 
 ```rust
-let btc_usd: Price = ...;
-let eth_usd: Price = ...;
+let btc_usd: PriceFeed = ...;
+let eth_usd: PriceFeed = ...;
 // Quantity of each asset in fixed-point a * 10^e.
 // This represents 0.1 BTC and .05 ETH.
 // -8 is desired exponent for result
-let basket_price: PriceConf = Price::price_basket(&[
+let basket_price: Price = Price::price_basket(&[
     (btc_usd, 10, -2),
     (eth_usd, 5, -2)
   ], -8);
@@ -121,7 +121,7 @@ This function additionally propagates any uncertainty in the price into uncertai
 
 ### Solana Account Structure
 
-> :warning: The Solana account structure is an internal API that is subject to change. Prefer to use `load_price` when possible.
+> :warning: The Solana account structure is an internal API that is subject to change. Prefer to use `load_price_feed_*` when possible.
 
 This library also provides several `load_*` methods that allow users to translate the binary data in each account into an appropriate struct:
 

pyth-sdk-solana/examples/eth_price.rs

@@ -1,6 +1,6 @@
 // example usage of reading pyth price from solana price account
 
-use pyth_sdk_solana::load_price_from_account;
+use pyth_sdk_solana::load_price_feed_from_account;
 use solana_client::rpc_client::RpcClient;
 use solana_program::pubkey::Pubkey;
 use std::str::FromStr;
@@ -20,13 +20,13 @@ fn main() {
     loop {
         // get price data from key
         let mut eth_price_account = clnt.get_account(&eth_price_key).unwrap();
-        let eth_price = load_price_from_account(&eth_price_key, &mut eth_price_account).unwrap();
+        let eth_price_feed = load_price_feed_from_account(&eth_price_key, &mut eth_price_account).unwrap();
 
         println!(".....ETH/USD.....");
-        println!("status .......... {:?}", eth_price.status);
-        println!("num_publishers .. {}", eth_price.num_publishers);
+        println!("status .......... {:?}", eth_price_feed.status);
+        println!("num_publishers .. {}", eth_price_feed.num_publishers);
 
-        let maybe_price = eth_price.get_current_price();
+        let maybe_price = eth_price_feed.get_current_price();
         match maybe_price {
             Some(p) => {
                 println!("price ........... {} x 10^{}", p.price, p.expo);
@@ -39,7 +39,7 @@ fn main() {
         }
 
 
-        let maybe_ema_price = eth_price.get_ema_price();
+        let maybe_ema_price = eth_price_feed.get_ema_price();
         match maybe_ema_price {
             Some(ema_price) => {
                 println!(

pyth-sdk-solana/examples/get_accounts.rs

@@ -70,11 +70,11 @@ fn main() {
                 loop {
                     let price_data = clnt.get_account_data(&px_pkey).unwrap();
                     let price_account = load_price_account(&price_data).unwrap();
-                    let price = price_account.to_price(&px_pkey);
+                    let price_feed = price_account.to_price_feed(&px_pkey);
 
                     println!("  price_account .. {:?}", px_pkey);
 
-                    let maybe_price = price.get_current_price();
+                    let maybe_price = price_feed.get_current_price();
                     match maybe_price {
                         Some(p) => {
                             println!("    price ........ {} x 10^{}", p.price, p.expo);
@@ -90,8 +90,8 @@ fn main() {
                         "    price_type ... {}",
                         get_price_type(&price_account.ptype)
                     );
-                    println!("    exponent ..... {}", price.expo);
-                    println!("    status ....... {}", get_status(&price.status));
+                    println!("    exponent ..... {}", price_feed.expo);
+                    println!("    status ....... {}", get_status(&price_feed.status));
                     println!(
                         "    corp_act ..... {}",
                         get_corp_act(&price_account.agg.corp_act)
@@ -101,7 +101,7 @@ fn main() {
                     println!("    valid_slot ... {}", price_account.valid_slot);
                     println!("    publish_slot . {}", price_account.agg.pub_slot);
 
-                    let maybe_ema_price = price.get_ema_price();
+                    let maybe_ema_price = price_feed.get_ema_price();
                     match maybe_ema_price {
                         Some(ema_price) => {
                             println!(

pyth-sdk-solana/src/lib.rs

@@ -19,26 +19,26 @@ use state::load_price_account;
 
 pub use pyth_sdk::{
     Price,
-    PriceConf,
+    PriceFeed,
     PriceStatus,
     ProductIdentifier,
 };
 
 /// Maximum valid slot period before price is considered to be stale.
 pub const VALID_SLOT_PERIOD: u64 = 25;
 
-/// Loads Pyth Price from Price Account Info.
-pub fn load_price_from_account_info(price_account_info: &AccountInfo) -> Result<Price, PythError> {
+/// Loads Pyth Feed Price from Price Account Info.
+pub fn load_price_feed_from_account_info(price_account_info: &AccountInfo) -> Result<PriceFeed, PythError> {
     let data = price_account_info.try_borrow_data().map_err(|_| PythError::InvalidAccountData)?;
     let price_account = load_price_account(*data)?;
 
-    Ok(price_account.to_price(&price_account_info.key))
+    Ok(price_account.to_price_feed(&price_account_info.key))
 }
 
-/// Loads Pyth Price from Account when using Solana Client.
+/// Loads Pyth Price Feed from Account when using Solana Client.
 ///
 /// It is a helper function which constructs Account Info when reading Account in clients.
-pub fn load_price_from_account(price_key: &Pubkey, price_account: &mut impl Account) -> Result<Price, PythError> {
+pub fn load_price_feed_from_account(price_key: &Pubkey, price_account: &mut impl Account) -> Result<PriceFeed, PythError> {
     let price_account_info = (price_key, price_account).into_account_info();
-    load_price_from_account_info(&price_account_info)
+    load_price_feed_from_account_info(&price_account_info)
 }

pyth-sdk-solana/src/state.rs

@@ -16,8 +16,8 @@ use solana_program::pubkey::Pubkey;
 use std::mem::size_of;
 
 pub use pyth_sdk::{
+    PriceFeed,
     Price,
-    PriceConf,
     PriceStatus,
 };
 
@@ -334,7 +334,7 @@ unsafe impl Pod for PriceAccount {
 }
 
 impl PriceAccount {
-    pub fn to_price(&self, price_key: &Pubkey) -> Price {
+    pub fn to_price_feed(&self, price_key: &Pubkey) -> PriceFeed {
         #[allow(unused_mut)]
         let mut status = self.agg.status;
 
@@ -345,7 +345,7 @@ impl PriceAccount {
             status = PriceStatus::Unknown;
         }
 
-        Price {
+        PriceFeed {
             id: price_key.to_bytes(),
             price: self.agg.price,
             conf: self.agg.conf,

pyth-sdk-solana/test-contract/src/instruction.rs

@@ -4,7 +4,7 @@ use bytemuck::bytes_of;
 
 use pyth_sdk_solana::state::PriceAccount;
 use pyth_sdk_solana::{
-    PriceConf,
+    Price,
     PriceStatus,
 };
 
@@ -20,23 +20,23 @@ use solana_program::instruction::Instruction;
 #[derive(Clone, Debug, BorshSerialize, BorshDeserialize, PartialEq)]
 pub enum PythClientInstruction {
     Divide {
-        numerator:   PriceConf,
-        denominator: PriceConf,
+        numerator:   Price,
+        denominator: Price,
     },
     Multiply {
-        x: PriceConf,
-        y: PriceConf,
+        x: Price,
+        y: Price,
     },
     Add {
-        x: PriceConf,
-        y: PriceConf,
+        x: Price,
+        y: Price,
     },
     ScaleToExponent {
-        x:    PriceConf,
+        x:    Price,
         expo: i32,
     },
     Normalize {
-        x: PriceConf,
+        x: Price,
     },
     /// Don't do anything for comparison
     ///
@@ -52,7 +52,7 @@ pub enum PythClientInstruction {
     },
 }
 
-pub fn divide(numerator: PriceConf, denominator: PriceConf) -> Instruction {
+pub fn divide(numerator: Price, denominator: Price) -> Instruction {
     Instruction {
         program_id: id(),
         accounts:   vec![],
@@ -65,7 +65,7 @@ pub fn divide(numerator: PriceConf, denominator: PriceConf) -> Instruction {
     }
 }
 
-pub fn multiply(x: PriceConf, y: PriceConf) -> Instruction {
+pub fn multiply(x: Price, y: Price) -> Instruction {
     Instruction {
         program_id: id(),
         accounts:   vec![],
@@ -75,15 +75,15 @@ pub fn multiply(x: PriceConf, y: PriceConf) -> Instruction {
     }
 }
 
-pub fn add(x: PriceConf, y: PriceConf) -> Instruction {
+pub fn add(x: Price, y: Price) -> Instruction {
     Instruction {
         program_id: id(),
         accounts:   vec![],
         data:       PythClientInstruction::Add { x, y }.try_to_vec().unwrap(),
     }
 }
 
-pub fn scale_to_exponent(x: PriceConf, expo: i32) -> Instruction {
+pub fn scale_to_exponent(x: Price, expo: i32) -> Instruction {
     Instruction {
         program_id: id(),
         accounts:   vec![],
@@ -93,7 +93,7 @@ pub fn scale_to_exponent(x: PriceConf, expo: i32) -> Instruction {
     }
 }
 
-pub fn normalize(x: PriceConf) -> Instruction {
+pub fn normalize(x: Price) -> Instruction {
     Instruction {
         program_id: id(),
         accounts:   vec![],

pyth-sdk-solana/test-contract/src/processor.rs

@@ -45,7 +45,7 @@ pub fn process_instruction(
             expected_price_status,
         } => {
             let price_account = load_price_account(price_account_data.as_ref())?;
-            let price = price_account.to_price(&Pubkey::default());
+            let price = price_account.to_price_feed(&Pubkey::default());
 
             if price.status == expected_price_status {
                 Ok(())

pyth-sdk-solana/test-contract/tests/instruction_count.rs

@@ -1,13 +1,13 @@
 use solana_program_test::*;
 use test_contract::instruction;
 
-use pyth_sdk_solana::PriceConf;
+use pyth_sdk_solana::Price;
 
 mod common;
 use common::test_instr_exec_ok;
 
-fn pc(price: i64, conf: u64, expo: i32) -> PriceConf {
-    PriceConf {
+fn pc(price: i64, conf: u64, expo: i32) -> Price {
+    Price {
         price: price,
         conf:  conf,
         expo:  expo,