feat(pyth-lazer-publisher-sdk): Add SDK for Publisher Transactions

.github/workflows/publish-rust-lazer-publisher-sdk.yml

@@ -0,0 +1,18 @@
+name: Publish Rust package pyth-lazer-publisher-sdk to crates.io
+
+on:
+  push:
+    tags:
+      - rust-pyth-lazer-publisher-sdk-v*
+jobs:
+  publish-pyth-lazer-publisher-sdk:
+    name: Publish Rust package pyth-lazer-publisher-sdk to crates.io
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - run: cargo publish --token ${CARGO_REGISTRY_TOKEN}
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        working-directory: "lazer/publisher-sdk/rust"

lazer/Cargo.toml

@@ -1,6 +1,7 @@
 [workspace]
 resolver = "2"
 members = [
+  "publisher_sdk/rust",
   "sdk/rust/protocol",
   "sdk/rust/client",
   "contracts/solana/programs/pyth-lazer-solana-contract",

lazer/publisher_sdk/proto/publisher_update.proto

@@ -0,0 +1,59 @@
+syntax = "proto3";
+
+import "google/protobuf/timestamp.proto";
+
+package pyth_lazer_transaction;
+
+// PublisherUpdate contains an array of individual updates and a timestamp
+message PublisherUpdate {
+  // Array of updates, each of which target a single feed
+  repeated FeedUpdate updates = 1;
+
+  // ID of the Publisher that is sending the update
+  // Should match ID stored in Pyth Lazer
+  optional uint32 publisher_id = 2;
+
+  // Timestamp when this message was created
+  optional google.protobuf.Timestamp publisher_timestamp = 3;
+}
+
+// Update to a feed. May contain different types of data depending on what kind of update it is
+message FeedUpdate {
+  // Feed which the update should be applied to
+  // Should match a feed id recognized by PythLazer
+  optional uint32 feed_id = 1;
+
+  // Timestamp when this data was first acquired or generated
+  optional google.protobuf.Timestamp source_timestamp = 2;
+
+  // one of the valid updates allowed by publishers for a lazer feed
+  oneof update {
+    PriceUpdate price_update = 3;
+    FundingRateUpdate funding_rate_update = 4;
+  };
+}
+
+message PriceUpdate {
+  // Price for the symbol as an integer
+  // Should be produced with a matching exponent to the configured exponent value in PythLazer
+  // May be missing if no price data is available
+  optional int64 price = 1;
+
+  // Best Bid Price for the symbol as an integer
+  // Should be produced with a matching exponent to the configured exponent value in PythLazer
+  // May be missing if no data is available
+  optional int64 best_bid_price = 2;
+
+  // Best Ask Price for the symbol as an integer
+  // Should be produced with a matching exponent to the configured exponent value in PythLazer
+  // May be missing if no data is available
+  optional int64 best_ask_price = 3;
+}
+
+message FundingRateUpdate {
+  // Price for which the funding rate applies to
+  optional int64 price = 1;
+
+  // Perpetual Future funding rate
+  optional int64 rate = 2;
+}

lazer/publisher_sdk/proto/pyth_lazer_transaction.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package pyth_lazer_transaction;
+
+import "publisher_update.proto";
+
+// Types of Signatures allowed for signing Lazer Transactions
+enum TransactionSignatureType {
+  // signature is 64 bytes long
+  ed25519 = 0;
+}
+
+// Signed lazer transaction payload
+// This is what Pyth Lazer expects as input to the system
+message SignedLazerTransaction {
+  // Type and signature should match
+  optional TransactionSignatureType signature_type = 1;
+
+  // Signature derived by signing payload with private key
+  optional bytes signature = 2;
+
+  // a LazerTransaction message which is already encoded with protobuf as bytes
+  // The encoded bytes are what should be signed
+  optional bytes payload = 3;
+}
+
+// Transaction contianing one of the valid Lazer Transactions
+message LazerTransaction {
+  oneof payload {
+    // Expected transaction sent by Publishers
+    // May contain many individual updates to various feeds
+    PublisherUpdate publisher_update = 1;
+  }
+}

lazer/publisher_sdk/rust/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "pyth-lazer-publisher-sdk"
+version = "0.1.0"
+edition = "2021"
+description = "Pyth Lazer Publisher SDK types."
+license = "Apache-2.0"
+repository = "https://github.com/pyth-network/pyth-crosschain"
+build = "build.rs"
+
+[dependencies]
+protobuf = "3.7.2"
+
+[build-dependencies]
+protobuf-codegen = "3.7.2"

lazer/publisher_sdk/rust/build.rs

@@ -0,0 +1,19 @@
+use std::io::Result;
+
+/// Automatically runs during cargo build.
+/// Proto files for Lazer are defined in the lazer sdk folder in the proto/ subdirectory.
+/// Both JS and Rust SDKs read the proto files for generating types.
+fn main() -> Result<()> {
+    // Tell cargo to recompile if any .proto files change
+    println!("cargo:rerun-if-changed=../proto/");
+
+    protobuf_codegen::Codegen::new()
+        .pure()
+        .include("../proto")
+        .input("../proto/publisher_update.proto")
+        .input("../proto/pyth_lazer_transaction.proto")
+        .cargo_out_dir("protobuf")
+        .run_from_script();
+
+    Ok(())
+}

lazer/publisher_sdk/rust/src/lib.rs

@@ -0,0 +1,7 @@
+pub mod transaction {
+    pub use crate::protobuf::pyth_lazer_transaction::*;
+}
+
+mod protobuf {
+    include!(concat!(env!("OUT_DIR"), "/protobuf/mod.rs"));
+}

lazer/sdk/js/turbo.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "dependsOn": ["^build"],
+      "outputs": ["dist/**"]
+    },
+    "build:cjs": {
+      "dependsOn": ["build"],
+      "outputs": ["dist/cjs/**"]
+    },
+    "build:esm": {
+      "dependsOn": ["build"],
+      "outputs": ["dist/esm/**"]
+    }
+  }
+}