Add schema generation for pyth-sdk (#45)

* Add schema generation for pyth-sdk

* Add comments + update action names

Author: ali-behjati

.github/workflows/pyth-sdk-example-terra-contract.yml

@@ -34,8 +34,8 @@ jobs:
         env:
           RUSTFLAGS: "-C link-arg=-s"
 
-  lints:
-    name: Lints
+  schema-check:
+    name: Check schema changes are committed
     runs-on: ubuntu-latest
     defaults:
       run:

.github/workflows/pyth-sdk-terra.yml

@@ -23,8 +23,8 @@ jobs:
       run: cargo build --verbose
     - name: Run tests
       run: cargo test --verbose
-  lints:
-    name: Lints
+  schema-check:
+    name: Check schema changes are committed
     runs-on: ubuntu-latest
     defaults:
       run:

.github/workflows/pyth-sdk.yml

@@ -25,3 +25,27 @@ jobs:
       run: cargo build --verbose
     - name: Run tests
       run: cargo test --verbose
+  schema-check:
+    name: Check schema changes are committed
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./pyth-sdk
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.58.1
+          override: true
+          components: clippy
+
+      - name: Generate Schema
+        run: cargo run --example schema
+
+      - name: Schema Changes
+        # fails if any changes not committed
+        run: git diff --exit-code schema

README.md

@@ -27,6 +27,12 @@ Please see the documentation for the relevant crate to get started using Pyth Ne
 All crates in this repository can be built for either your native platform or blockchain-specific platforms.
 Use `cargo build` / `cargo test` to build and test natively.
 
+### Schema Files
+
+JSON Schema files are provided to allow others to work with the various Pyth structures in languages other than Rust. These are also used within Pyth’s own repositories, for example within the pyth-sdk-js repo. Every time these structures change, new Schema’s must be generated and committed via the cargo run --example schema command.
+
+There is currently a CI check which ensures the schema files remain up-to-date.
+
 ### Creating a Release
 
 To release a new version of any of these crates, perform the following steps within the crate being released:

pyth-sdk/examples/schema.rs

@@ -0,0 +1,21 @@
+use schemars::schema_for;
+use serde_json::to_string_pretty;
+use std::env::current_dir;
+use std::fs::{
+    create_dir_all,
+    write,
+};
+
+use pyth_sdk::PriceFeed;
+
+fn main() {
+    let mut out_dir = current_dir().unwrap();
+    out_dir.push("schema");
+    create_dir_all(&out_dir).unwrap();
+
+    let schema = &schema_for!(PriceFeed);
+    let json = to_string_pretty(schema).unwrap();
+    let path = out_dir.join(format!("{}.json", "price_feed"));
+    write(&path, json + "\n").unwrap();
+    println!("Updated {}", path.to_str().unwrap());
+}

pyth-sdk/schema/price_feed.json

@@ -0,0 +1,114 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "PriceFeed",
+  "description": "Represents a current aggregation price from pyth publisher feeds.",
+  "type": "object",
+  "required": [
+    "conf",
+    "ema_conf",
+    "ema_price",
+    "expo",
+    "id",
+    "max_num_publishers",
+    "num_publishers",
+    "prev_conf",
+    "prev_price",
+    "prev_publish_time",
+    "price",
+    "product_id",
+    "publish_time",
+    "status"
+  ],
+  "properties": {
+    "conf": {
+      "description": "Confidence interval around the current aggregation price.",
+      "type": "string"
+    },
+    "ema_conf": {
+      "description": "Exponentially moving average confidence interval.",
+      "type": "string"
+    },
+    "ema_price": {
+      "description": "Exponentially moving average price.",
+      "type": "string"
+    },
+    "expo": {
+      "description": "Price exponent.",
+      "type": "integer",
+      "format": "int32"
+    },
+    "id": {
+      "description": "Unique identifier for this price.",
+      "allOf": [
+        {
+          "$ref": "#/definitions/Identifier"
+        }
+      ]
+    },
+    "max_num_publishers": {
+      "description": "Maximum number of allowed publishers that can contribute to a price.",
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0.0
+    },
+    "num_publishers": {
+      "description": "Number of publishers that made up current aggregate.",
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0.0
+    },
+    "prev_conf": {
+      "description": "Confidence interval of previous aggregate with Trading status.",
+      "type": "string"
+    },
+    "prev_price": {
+      "description": "Price of previous aggregate with Trading status.",
+      "type": "string"
+    },
+    "prev_publish_time": {
+      "description": "Publish time of previous aggregate with Trading status.",
+      "type": "integer",
+      "format": "int64"
+    },
+    "price": {
+      "description": "The current aggregation price.",
+      "type": "string"
+    },
+    "product_id": {
+      "description": "Product account key.",
+      "allOf": [
+        {
+          "$ref": "#/definitions/Identifier"
+        }
+      ]
+    },
+    "publish_time": {
+      "description": "Current price aggregation publish time",
+      "type": "integer",
+      "format": "int64"
+    },
+    "status": {
+      "description": "Status of price (Trading is valid).",
+      "allOf": [
+        {
+          "$ref": "#/definitions/PriceStatus"
+        }
+      ]
+    }
+  },
+  "definitions": {
+    "Identifier": {
+      "type": "string"
+    },
+    "PriceStatus": {
+      "description": "Represents availability status of a price feed.",
+      "type": "string",
+      "enum": [
+        "Unknown",
+        "Trading",
+        "Halted",
+        "Auction"
+      ]
+    }
+  }
+}