feat(pyth-lazer-protocol): Implement Protobuf files for Lazer Transactions

lazer/sdk/js/.gitignore

@@ -20,3 +20,6 @@ node_modules/
 dist/
 
 tsconfig.tsbuildinfo
+
+# Types generated for .proto files
+src/generated/*

lazer/sdk/js/README.md

@@ -3,3 +3,15 @@
 ## Contributing & Development
 
 See [contributing.md](docs/contributing/contributing.md) for information on how to develop or contribute to this project!
+
+## Installation and build
+
+### pnpm
+
+```
+cd to crosschain root
+$ pnpm install
+$ pnpm turbo --filter @pythnetwork/pyth-lazer-sdk build
+```
+
+As part of the build, files will be generated from the proto files found in the lazer/proto folder. These generated files are placed in the src/generated/ folder. 

lazer/sdk/js/examples/index.ts

@@ -4,7 +4,7 @@
 import { PythLazerClient } from "../src/index.js";
 
 // Ignore debug messages
-console.debug = () => {};
+console.debug = () => { };
 
 const client = await PythLazerClient.create(
   ["wss://pyth-lazer.dourolabs.app/v1/stream"],

lazer/sdk/js/package.json

@@ -21,6 +21,7 @@
     }
   },
   "scripts": {
+    "build:proto-codegen": "mkdir -p src/generated && pnpm exec pbjs -t static-module -w es6 -o src/generated/proto.js ../proto/*.proto && pnpm exec pbts -o src/generated/proto.d.ts src/generated/proto.js",
     "build:cjs": "tsc --project tsconfig.build.json --verbatimModuleSyntax false --module commonjs --outDir ./dist/cjs && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
     "build:esm": "tsc --project tsconfig.build.json --outDir ./dist/esm && echo '{\"type\":\"module\"}' > dist/esm/package.json",
     "fix:lint": "eslint --fix . --max-warnings 0",
@@ -30,6 +31,7 @@
     "fix:format": "prettier --write .",
     "example": "node --loader ts-node/esm examples/index.js",
     "doc": "typedoc --out docs/typedoc src",
+    "prepublishOnly": "pnpm run build",
     "publish": "pnpm run script -- publish"
   },
   "devDependencies": {
@@ -39,6 +41,8 @@
     "@types/ws": "^8.5.12",
     "eslint": "catalog:",
     "prettier": "catalog:",
+    "protobufjs": "^7.4.0",
+    "protobufjs-cli": "^1.1.3",
     "ts-node": "catalog:",
     "typedoc": "^0.26.8",
     "typescript": "catalog:"

lazer/sdk/js/turbo.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "extends": ["//"],
+  "tasks": {
+    "build:proto-codegen": {
+      "dependsOn": ["//#install:modules"],
+      "inputs": ["../proto/**"],
+      "outputs": ["src/generated/**"],
+      "cache": false
+    },
+    "build": {
+      "dependsOn": ["build:proto-codegen", "^build"],
+      "outputs": ["dist/**"]
+    },
+    "build:cjs": {
+      "dependsOn": ["build:proto-codegen"],
+      "outputs": ["dist/cjs/**"]
+    },
+    "build:esm": {
+      "dependsOn": ["build:proto-codegen"],
+      "outputs": ["dist/esm/**"]
+    }
+  }
+}

lazer/sdk/proto/publisher_update.proto

@@ -0,0 +1,55 @@
+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;
+
+  // Timestamp when this message was created
+  optional google.protobuf.Timestamp publisher_timestamp = 2;
+}
+
+// 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/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/sdk/rust/protocol/Cargo.toml

@@ -1,10 +1,11 @@
 [package]
 name = "pyth-lazer-protocol"
-version = "0.7.0"
+version = "0.7.1"
 edition = "2021"
 description = "Pyth Lazer SDK - protocol types."
 license = "Apache-2.0"
 repository = "https://github.com/pyth-network/pyth-crosschain"
+build = "build.rs"
 
 [dependencies]
 byteorder = "1.5.0"
@@ -15,6 +16,8 @@ derive_more = { version = "1.0.0", features = ["from"] }
 itertools = "0.13.0"
 rust_decimal = "1.36.0"
 base64 = "0.22.1"
+prost = "0.13.5"
+prost-types = "0.13.5"
 
 [dev-dependencies]
 bincode = "1.3.3"
@@ -23,3 +26,6 @@ hex = "0.4.3"
 libsecp256k1 = "0.7.1"
 bs58 = "0.5.1"
 alloy-primitives = "0.8.19"
+
+[build-dependencies]
+prost-build = "0.13.5"

lazer/sdk/rust/protocol/build.rs

@@ -0,0 +1,22 @@
+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/");
+
+    // Selects proto files to be read for compiling
+    let proto_files = vec![
+        "../../proto/pyth_lazer_transaction.proto",
+        "../../proto/publisher_update.proto",
+    ];
+
+    // Compiles protos and generates Rust types
+    // Generated types are present in the output folder
+    prost_build::compile_protos(&proto_files, &["../../proto"])
+        .expect("Failed to compile protos and generate types");
+
+    Ok(())
+}

lazer/sdk/rust/protocol/src/lib.rs

@@ -10,6 +10,9 @@ mod serde_price_as_i64;
 mod serde_str;
 pub mod subscription;
 pub mod symbol_state;
+pub mod transaction {
+    include!(concat!(env!("OUT_DIR"), "/pyth_lazer_transaction.rs"));
+}
 
 #[test]
 fn magics_in_big_endian() {