Add pre-commit to the repo (#40)

Author: ali-bahjati

.github/workflows/check-formatting.yml

@@ -0,0 +1,19 @@
+name: Check Formatting
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: nightly
+        components: rustfmt
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.2.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-added-large-files
+- repo: local
+  hooks:
+    - id: cargo-fmt-nightly
+      name: Cargo Fmt Nightly
+      language: "rust"
+      entry: cargo +nightly fmt
+      pass_filenames: false

README.md

@@ -36,3 +36,8 @@ To release a new version of any of these crates, perform the following steps wit
 2. Merge your change into `main` on github.
 3. Create and publish a new github release.
    We currently don't have a Github Action to automatically push releases to [crates.io](https://crates.io), but should set one up.
+
+### pre-commit hooks
+pre-commit is a tool that checks and fixes simple issues (formatting, ...) before each commit. You can install it by following [their website](https://pre-commit.com/). In order to enable checks for this repo run `pre-commit install` from command-line in the root of this repo.
+
+The checks are also performed in the CI to ensure the code follows consistent formatting.

examples/terra-contract/README.md

@@ -1,12 +1,12 @@
 # Pyth SDK Example Contract for Terra
 
-This repository contains an example contract that demonstrates how to read the Pyth price from the Pyth on-chain contract. 
-The example [contract](src/contract.rs) has two functions: 
+This repository contains an example contract that demonstrates how to read the Pyth price from the Pyth on-chain contract.
+The example [contract](src/contract.rs) has two functions:
 
-* `instantiate` sets the Pyth contract address and price feed id that the contract uses. 
+* `instantiate` sets the Pyth contract address and price feed id that the contract uses.
   This function is intended to be called once when the contract is deployed.
-  See the [Terra SDK README](../../pyth-sdk-terra/README.md) for the list of possible price feed ids. 
-* `query` queries the Pyth contract to get the current price for the configured price feed id. 
+  See the [Terra SDK README](../../pyth-sdk-terra/README.md) for the list of possible price feed ids.
+* `query` queries the Pyth contract to get the current price for the configured price feed id.
 
 ## Testnet Demo
 
@@ -40,7 +40,7 @@ rpc error: code = Unknown desc = Generic error: Current price is not available:
 If you would like to deploy a changed version of this contract, the process consists of two steps:
 
 1. Build the WASM for the contract.
-2. Upload the code and instantiate a new contract. 
+2. Upload the code and instantiate a new contract.
 
 ### Build WASM
 
@@ -50,7 +50,7 @@ The instructions in that document will build a file called `example_terra_contra
 ### Upload and Instantiate Contract
 
 The tools directory contains a deployment script that will upload a WASM file and instantiate a new contract with it.
-You can run that script on the built WASM file as follows: 
+You can run that script on the built WASM file as follows:
 
 ``` sh
 cd tools/
@@ -76,7 +76,7 @@ By default, the deployment script sets the price feed to `Crypto.LUNA/USD` but y
 
 ### Querying the Contract
 
-Once the contract is instantiated, you can query it by running: 
+Once the contract is instantiated, you can query it by running:
 
 ```sh
 npm run query -- --network testnet --contract <contract address>
@@ -106,4 +106,4 @@ Contract terra1rhjej5gkyelw23uh22nadqlyjvtl7s5527er97 code_id successfully updat
 When deploying the contract, you may encounter gateway timeout or account sequence mismatch errors.
 If this happens, check terra finder to determine if your transaction succeeded -- sometimes transactions succeed despite timing out.
 Note that the deployment script submits multiple transactions.
-If any of them fails, simply rerun the entire script; there is no problem re-running the successful transactions. 
+If any of them fails, simply rerun the entire script; there is no problem re-running the successful transactions.

examples/terra-contract/src/contract.rs

@@ -40,9 +40,9 @@ pub fn instantiate(
     _info: MessageInfo,
     msg: InstantiateMsg,
 ) -> StdResult<Response> {
-    // It is a good practice that your contract stores the pyth contract address and ids of the price feeds
-    // it needs upon instantiation or by an authorized approach. This will ensure that a wrong address won't
-    // be used.
+    // It is a good practice that your contract stores the pyth contract address and ids of the
+    // price feeds it needs upon instantiation or by an authorized approach. This will ensure
+    // that a wrong address won't be used.
     let state = State {
         pyth_contract_addr: deps.api.addr_validate(msg.pyth_contract_addr.as_ref())?,
         price_feed_id:      msg.price_feed_id,
@@ -76,9 +76,10 @@ fn query_fetch_price(deps: Deps) -> StdResult<FetchPriceResponse> {
     let state = STATE.load(deps.storage)?;
 
     // query_price_feed is the standard way to read the current price from a Pyth price feed.
-    // It takes the address of the Pyth contract (which is fixed for each network) and the id of the price feed.
-    // The result is a PriceFeed object with fields for the current price and other useful information.
-    // The function will fail if the contract address or price feed id are invalid.
+    // It takes the address of the Pyth contract (which is fixed for each network) and the id of the
+    // price feed. The result is a PriceFeed object with fields for the current price and other
+    // useful information. The function will fail if the contract address or price feed id are
+    // invalid.
     let price_feed = query_price_feed(
         &deps.querier,
         state.pyth_contract_addr.into_string(),
@@ -88,11 +89,11 @@ fn query_fetch_price(deps: Deps) -> StdResult<FetchPriceResponse> {
 
     // Get the current price and confidence interval from the price feed.
     // This function returns None if the price is not currently available.
-    // This condition can happen for various reasons. For example, some products only trade at specific times, or
-    // network outages may prevent the price feed from updating.
+    // This condition can happen for various reasons. For example, some products only trade at
+    // specific times, or network outages may prevent the price feed from updating.
     //
-    // The example code below throws an error if the price is not available. It is recommended that you handle
-    // this scenario more carefully. Consult the [consumer best practices](https://docs.pyth.network/consumers/best-practices)
+    // The example code below throws an error if the price is not available. It is recommended that
+    // you handle this scenario more carefully. Consult the [consumer best practices](https://docs.pyth.network/consumers/best-practices)
     // for recommendations.
     let current_price = price_feed
         .get_current_price()

examples/terra-contract/src/msg.rs

@@ -1,6 +1,6 @@
 use pyth_sdk_terra::{
     Price,
-    PriceIdentifier
+    PriceIdentifier,
 };
 use schemars::JsonSchema;
 use serde::{
@@ -31,5 +31,5 @@ pub enum QueryMsg {
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
 pub struct FetchPriceResponse {
     pub current_price: Price,
-    pub ema_price: Price,
+    pub ema_price:     Price,
 }

examples/terra-contract/tools/deploy.js

@@ -234,4 +234,4 @@ function convert_terra_address_to_hex(human_addr) {
 
 function sleep(ms) {
   return new Promise(resolve => setTimeout(resolve, ms));
-}
+}

examples/terra-contract/tools/query.js

@@ -29,7 +29,7 @@ const CONFIG = {
     },
   }
 }
-  
+
 const lcd = new LCDClient(CONFIG[argv.network].terraHost);
 
 

pyth-sdk-solana/README.md

@@ -1,4 +1,4 @@
-# Pyth Network Solana SDK 
+# Pyth Network Solana SDK
 
 This crate provides utilities for reading price feeds from the [pyth.network](https://pyth.network/) oracle on the Solana network.
 It also includes several [off-chain example programs](examples/).
@@ -74,7 +74,7 @@ This library also provides several `load_*` methods that allow users to translat
 ```rust
 use pyth_sdk_solana::state::*;
 
-// replace with account data, either passed to on-chain program or from RPC node 
+// replace with account data, either passed to on-chain program or from RPC node
 let price_account_data: Vec<u8> = ...;
 let price_account: &PriceAccount = load_price_account( &price_account_data ).unwrap();
 
@@ -140,6 +140,6 @@ product_account .. 6MEwdxe4g1NeAF9u6KDG14anJpFsVEa2cvr5H6iriFZ8
 
 ## Development
 
-This library can be built for either your native platform or in BPF (used by Solana programs). 
+This library can be built for either your native platform or in BPF (used by Solana programs).
 Use `cargo build` / `cargo test` to build and test natively.
-Use `cargo build-bpf` / `cargo test-bpf` to build in BPF for Solana; these commands require you to have installed the [Solana CLI tools](https://docs.solana.com/cli/install-solana-cli-tools). 
+Use `cargo build-bpf` / `cargo test-bpf` to build in BPF for Solana; these commands require you to have installed the [Solana CLI tools](https://docs.solana.com/cli/install-solana-cli-tools).

pyth-sdk-solana/test-contract/README.md

@@ -2,7 +2,7 @@
 This contract is used to test pyth-sdk-solana onchain.
 
 ## Development
-Use `cargo build-bpf` / `cargo test-bpf` to build in BPF for Solana; these commands require you to have installed the [Solana CLI tools](https://docs.solana.com/cli/install-solana-cli-tools). 
+Use `cargo build-bpf` / `cargo test-bpf` to build in BPF for Solana; these commands require you to have installed the [Solana CLI tools](https://docs.solana.com/cli/install-solana-cli-tools).
 
 The BPF tests will also run an instruction count program that logs the resource consumption
 of various library functions.

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

@@ -16,9 +16,9 @@ use common::test_instr_exec_ok;
 
 fn price_account_all_zero() -> PriceAccount {
     PriceAccount {
-        magic:      MAGIC,
-        ver:        VERSION_2,
-        atype:      AccountType::Price as u32,
+        magic: MAGIC,
+        ver: VERSION_2,
+        atype: AccountType::Price as u32,
         ..Default::default()
     }
 }

pyth-sdk-terra/README.md

@@ -65,10 +65,10 @@ List of available Price Feeds and their ids:
 | Crypto.BTC/USD  | `0xf9c0172ba10dfa4d19088d94f5bf61d3b54d5bd7483a322a982e1373ee8ea31b` |
 | Crypto.ETH/USD  | `0xca80ba6dc32e08d06f1aa886011eed1d77c77be9eb761cc10d72b7d0a2fd57a6` |
 | Crypto.LUNA/USD | `0x6de025a4cf28124f8ea6cb8085f860096dbc36d9c40002e221fc449337e065b2` |
-| Crypto.UST/USD  | `0x026d1f1cf9f1c0ee92eb55696d3bd2393075b611c4f468ae5b967175edc4c25c` | 
+| Crypto.UST/USD  | `0x026d1f1cf9f1c0ee92eb55696d3bd2393075b611c4f468ae5b967175edc4c25c` |
 | Crypto.ALGO/USD | `0x08f781a893bc9340140c5f89c8a96f438bcfae4d1474cc0f688e3a52892c7318` |
 
 Testnet price feeds update once per minute.
 
 #### Notes
-- :warning: `num_publishers` and `max_num_publishers` in `PriceFeed` are currently unavailable and set to 0. 
+- :warning: `num_publishers` and `max_num_publishers` in `PriceFeed` are currently unavailable and set to 0.

pyth-sdk/README.md

@@ -16,7 +16,7 @@ Once you have a `PriceFeed`, you can call one of the methods below to get the pr
 
 ### Get the Current Price
 
-Get the current price of the product from its `PriceFeed`: 
+Get the current price of the product from its `PriceFeed`:
 
 ```rust
 let current_price: Price = price_feed.get_current_price().ok_or(StdError::not_found("Current price is not available"))?;
@@ -53,7 +53,7 @@ Applications can combine two USD prices to price an asset in a different quote c
 ```rust
 let btc_usd: Price = ...;
 let eth_usd: Price = ...;
-// -8 is the desired exponent for the result 
+// -8 is the desired exponent for the result
 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);
 ```