@pythnetwork/pyth-lazer-sdk 7.0.0 → 7.1.0

package/README.md

@@ -25,8 +25,8 @@ const client = await PythLazerClient.create({
 
     // Optional.
     // Override the stream endpoint(s). Round-robined across `numConnections`.
-    // Defaults to the api service instances (pyth-0/1/2.dourolabs.app).
-    // urls: ["wss://pyth-0.dourolabs.app/v1/prices/stream"],
+    // Defaults to the redundant router stream instances (pyth-lazer-0/1/2).
+    // urls: ["wss://pyth-lazer-0.dourolabs.app/v1/stream"],
     onWebSocketError: (error) => {
       console.error("⛔️ WebSocket error:", error.message);
     },
@@ -74,15 +74,14 @@ browser and in Node. It is never placed in the URL as a query parameter, so the
 token stays out of URLs, browser history, and proxy/server access logs — worth
 knowing if you care about credential hygiene.
 
-Connections default to the redundant Lazer api service stream instances
-(`wss://pyth-{0,1,2}.dourolabs.app/v1/prices/stream`), round-robined across
+Connections default to the redundant Lazer router stream instances
+(`wss://pyth-lazer-{0,1,2}.dourolabs.app/v1/stream`), round-robined across
 `numConnections` (override via `webSocketPoolConfig.urls`). They serve parsed /
-unsigned JSON updates; signed `evm` / `solana` update payloads are not served on
-this stream.
+unsigned JSON updates; signed `evm` / `solana` update payloads require the
+router stream with signature support.
 
 > **v7 breaking change:** the token moved from `?ACCESS_TOKEN=` to
-> `Sec-WebSocket-Protocol`, and the default stream moved from the router to the
-> api service. See [CHANGELOG.md](CHANGELOG.md).
+> `Sec-WebSocket-Protocol`. See [CHANGELOG.md](CHANGELOG.md).
 
 ## Error callbacks and outage detection
 

package/dist/cjs/client.cjs

@@ -113,7 +113,17 @@ class PythLazerClient {
                 pos += UINT16_NUM_BYTES;
                 const magic = buffData.subarray(pos, pos + UINT32_NUM_BYTES).readUint32LE();
                 if (magic === _protocol.FORMAT_MAGICS_LE.EVM) {
-                    value.evm = buffData.subarray(pos, pos + len);
+                    // `evm` and `packedEvmEcdsa` messages share the EVM envelope and its
+                    // magic. Only the magic at the start of the payload tells them apart.
+                    const message = buffData.subarray(pos, pos + len);
+                    const payloadMagic = readPayloadMagicBE(message.subarray(71));
+                    if (payloadMagic === _protocol.PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE) {
+                        value.packedEvmEcdsa = message;
+                    } else if (payloadMagic === _protocol.PAYLOAD_FORMAT_MAGIC_BE) {
+                        value.evm = message;
+                    } else {
+                        throw new Error(`unknown payload magic: ${payloadMagic.toString()}`);
+                    }
                 } else if (magic === _protocol.FORMAT_MAGICS_LE.SOLANA) {
                     value.solana = buffData.subarray(pos, pos + len);
                 } else if (magic === _protocol.FORMAT_MAGICS_LE.LE_ECDSA) {
@@ -264,3 +274,9 @@ class PythLazerClient {
         }
     }
 }
+function readPayloadMagicBE(payload) {
+    if (payload.length < UINT32_NUM_BYTES) {
+        throw new Error(`payload too short to hold a magic: ${payload.length.toString()} bytes`);
+    }
+    return payload.readUint32BE(0);
+}

package/dist/cjs/client.d.ts

@@ -8,6 +8,7 @@ export type BinaryResponse = {
     parsed?: ParsedPayload | undefined;
     leEcdsa?: Buffer | undefined;
     leUnsigned?: Buffer | undefined;
+    packedEvmEcdsa?: Buffer | undefined;
 };
 export type JsonOrBinaryResponse = {
     type: "json";

package/dist/cjs/constants.cjs

@@ -33,8 +33,8 @@ const SOLANA_LAZER_STORAGE_ID = "3rdJbqfnagQ4yx9HXJViD4zc4xpiSqmFsKpPuSCQVyQL";
 const DEFAULT_METADATA_SERVICE_URL = "https://pyth.dourolabs.app";
 const DEFAULT_PRICE_SERVICE_URL = "https://pyth-lazer-0.dourolabs.app";
 const DEFAULT_STREAM_SERVICE_URLS = [
-    "wss://pyth-0.dourolabs.app/v1/prices/stream",
-    "wss://pyth-1.dourolabs.app/v1/prices/stream",
-    "wss://pyth-2.dourolabs.app/v1/prices/stream"
+    "wss://pyth-lazer-0.dourolabs.app/v1/stream",
+    "wss://pyth-lazer-1.dourolabs.app/v1/stream",
+    "wss://pyth-lazer-2.dourolabs.app/v1/stream"
 ];
 const AUTH_SUBPROTOCOL = "pyth-lazer-auth";

package/dist/cjs/constants.d.ts

@@ -4,8 +4,8 @@ export declare const DEFAULT_METADATA_SERVICE_URL = "https://pyth.dourolabs.app"
 export declare const DEFAULT_PRICE_SERVICE_URL = "https://pyth-lazer-0.dourolabs.app";
 /**
  * Default stream endpoints, round-robined across the pool's connections when
- * the caller does not supply their own `urls`. These are redundant instances
- * of the Lazer api-service stream.
+ * the caller does not supply their own `urls`. These are redundant router
+ * instances.
  */
 export declare const DEFAULT_STREAM_SERVICE_URLS: string[];
 /**

package/dist/cjs/protocol.cjs

@@ -17,6 +17,12 @@ _export(exports, {
     },
     get FORMAT_MAGICS_LE () {
         return FORMAT_MAGICS_LE;
+    },
+    get PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE () {
+        return PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE;
+    },
+    get PAYLOAD_FORMAT_MAGIC_BE () {
+        return PAYLOAD_FORMAT_MAGIC_BE;
     }
 });
 const BINARY_UPDATE_FORMAT_MAGIC_LE = 461_928_307;
@@ -27,6 +33,8 @@ const FORMAT_MAGICS_LE = {
     LE_UNSIGNED: 1_499_680_012,
     SOLANA: 2_182_742_457
 };
+const PAYLOAD_FORMAT_MAGIC_BE = 2_479_346_549;
+const PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE = 1_128_617_549;
 var CustomSocketClosureCodes = /*#__PURE__*/ function(CustomSocketClosureCodes) {
     CustomSocketClosureCodes[CustomSocketClosureCodes["CLIENT_TIMEOUT_BUT_RECONNECTING"] = 4000] = "CLIENT_TIMEOUT_BUT_RECONNECTING";
     return CustomSocketClosureCodes;

package/dist/cjs/protocol.d.ts

@@ -1,4 +1,4 @@
-export type Format = "evm" | "solana" | "leEcdsa" | "leUnsigned";
+export type Format = "evm" | "solana" | "leEcdsa" | "leUnsigned" | "packedEvmEcdsa";
 export type DeliveryFormat = "json" | "binary";
 export type JsonBinaryEncoding = "base64" | "hex";
 export type PriceFeedProperty = "price" | "bestBidPrice" | "bestAskPrice" | "exponent" | "publisherCount" | "confidence" | "fundingRate" | "fundingTimestamp" | "fundingRateInterval" | "marketSession" | "emaPrice" | "emaConfidence" | "feedUpdateTimestamp";
@@ -8,7 +8,8 @@ export type Request = {
     subscriptionId: number;
     priceFeedIds?: number[] | undefined;
     symbols?: string[] | undefined;
-    properties: PriceFeedProperty[];
+    /** Required unless `formats` is `["packedEvmEcdsa"]`, which fixes the properties itself and accepts none. */
+    properties?: PriceFeedProperty[] | undefined;
     formats: Format[];
     deliveryFormat?: DeliveryFormat | undefined;
     jsonBinaryEncoding?: JsonBinaryEncoding | undefined;
@@ -75,6 +76,7 @@ export type Response = {
     solana?: JsonBinaryData | undefined;
     leEcdsa?: JsonBinaryData | undefined;
     leUnsigned?: JsonBinaryData | undefined;
+    packedEvmEcdsa?: JsonBinaryData | undefined;
 };
 export declare const BINARY_UPDATE_FORMAT_MAGIC_LE = 461928307;
 export declare const FORMAT_MAGICS_LE: {
@@ -84,6 +86,10 @@ export declare const FORMAT_MAGICS_LE: {
     LE_UNSIGNED: number;
     SOLANA: number;
 };
+/** The magic at the start of a standard payload serialized as big-endian, read as a big-endian u32. */
+export declare const PAYLOAD_FORMAT_MAGIC_BE = 2479346549;
+/** The magic at the start of a `packedEvmEcdsa` payload: `CEVM`, read as a big-endian u32. */
+export declare const PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE = 1128617549;
 export type AssetType = "crypto" | "fx" | "equity" | "metal" | "rates" | "nav" | "commodity" | "funding-rate" | "eco" | "kalshi";
 export type SymbolsQueryParams = {
     query?: string;
@@ -107,7 +113,8 @@ export type SymbolResponse = {
 export type LatestPriceRequest = {
     priceFeedIds?: number[];
     symbols?: string[];
-    properties: PriceFeedProperty[];
+    /** Required unless `formats` is `["packedEvmEcdsa"]`, which fixes the properties itself and accepts none. */
+    properties?: PriceFeedProperty[];
     formats: Format[];
     jsonBinaryEncoding?: JsonBinaryEncoding;
     parsed?: boolean;
@@ -117,7 +124,8 @@ export type PriceRequest = {
     timestamp: number;
     priceFeedIds?: number[];
     symbols?: string[];
-    properties: PriceFeedProperty[];
+    /** Required unless `formats` is `["packedEvmEcdsa"]`, which fixes the properties itself and accepts none. */
+    properties?: PriceFeedProperty[];
     formats: Format[];
     jsonBinaryEncoding?: JsonBinaryEncoding;
     parsed?: boolean;
@@ -129,6 +137,7 @@ export type JsonUpdate = {
     solana?: JsonBinaryData;
     leEcdsa?: JsonBinaryData;
     leUnsigned?: JsonBinaryData;
+    packedEvmEcdsa?: JsonBinaryData;
 };
 export declare enum CustomSocketClosureCodes {
     CLIENT_TIMEOUT_BUT_RECONNECTING = 4000

package/dist/esm/client.d.ts

@@ -8,6 +8,7 @@ export type BinaryResponse = {
     parsed?: ParsedPayload | undefined;
     leEcdsa?: Buffer | undefined;
     leUnsigned?: Buffer | undefined;
+    packedEvmEcdsa?: Buffer | undefined;
 };
 export type JsonOrBinaryResponse = {
     type: "json";

package/dist/esm/client.mjs

@@ -1,6 +1,6 @@
 import { dummyLogger } from "ts-log";
 import { DEFAULT_METADATA_SERVICE_URL, DEFAULT_PRICE_SERVICE_URL } from "./constants.mjs";
-import { BINARY_UPDATE_FORMAT_MAGIC_LE, FORMAT_MAGICS_LE } from "./protocol.mjs";
+import { BINARY_UPDATE_FORMAT_MAGIC_LE, FORMAT_MAGICS_LE, PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE, PAYLOAD_FORMAT_MAGIC_BE } from "./protocol.mjs";
 import { WebSocketPool } from "./socket/websocket-pool.mjs";
 import { bufferFromWebsocketData } from "./util/buffer-util.mjs";
 const UINT16_NUM_BYTES = 2;
@@ -103,7 +103,17 @@ export class PythLazerClient {
                 pos += UINT16_NUM_BYTES;
                 const magic = buffData.subarray(pos, pos + UINT32_NUM_BYTES).readUint32LE();
                 if (magic === FORMAT_MAGICS_LE.EVM) {
-                    value.evm = buffData.subarray(pos, pos + len);
+                    // `evm` and `packedEvmEcdsa` messages share the EVM envelope and its
+                    // magic. Only the magic at the start of the payload tells them apart.
+                    const message = buffData.subarray(pos, pos + len);
+                    const payloadMagic = readPayloadMagicBE(message.subarray(71));
+                    if (payloadMagic === PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE) {
+                        value.packedEvmEcdsa = message;
+                    } else if (payloadMagic === PAYLOAD_FORMAT_MAGIC_BE) {
+                        value.evm = message;
+                    } else {
+                        throw new Error(`unknown payload magic: ${payloadMagic.toString()}`);
+                    }
                 } else if (magic === FORMAT_MAGICS_LE.SOLANA) {
                     value.solana = buffData.subarray(pos, pos + len);
                 } else if (magic === FORMAT_MAGICS_LE.LE_ECDSA) {
@@ -254,3 +264,9 @@ export class PythLazerClient {
         }
     }
 }
+function readPayloadMagicBE(payload) {
+    if (payload.length < UINT32_NUM_BYTES) {
+        throw new Error(`payload too short to hold a magic: ${payload.length.toString()} bytes`);
+    }
+    return payload.readUint32BE(0);
+}

package/dist/esm/constants.d.ts

@@ -4,8 +4,8 @@ export declare const DEFAULT_METADATA_SERVICE_URL = "https://pyth.dourolabs.app"
 export declare const DEFAULT_PRICE_SERVICE_URL = "https://pyth-lazer-0.dourolabs.app";
 /**
  * Default stream endpoints, round-robined across the pool's connections when
- * the caller does not supply their own `urls`. These are redundant instances
- * of the Lazer api-service stream.
+ * the caller does not supply their own `urls`. These are redundant router
+ * instances.
  */
 export declare const DEFAULT_STREAM_SERVICE_URLS: string[];
 /**

package/dist/esm/constants.mjs

@@ -4,12 +4,12 @@ export const DEFAULT_METADATA_SERVICE_URL = "https://pyth.dourolabs.app";
 export const DEFAULT_PRICE_SERVICE_URL = "https://pyth-lazer-0.dourolabs.app";
 /**
  * Default stream endpoints, round-robined across the pool's connections when
- * the caller does not supply their own `urls`. These are redundant instances
- * of the Lazer api-service stream.
+ * the caller does not supply their own `urls`. These are redundant router
+ * instances.
  */ export const DEFAULT_STREAM_SERVICE_URLS = [
-    "wss://pyth-0.dourolabs.app/v1/prices/stream",
-    "wss://pyth-1.dourolabs.app/v1/prices/stream",
-    "wss://pyth-2.dourolabs.app/v1/prices/stream"
+    "wss://pyth-lazer-0.dourolabs.app/v1/stream",
+    "wss://pyth-lazer-1.dourolabs.app/v1/stream",
+    "wss://pyth-lazer-2.dourolabs.app/v1/stream"
 ];
 /**
  * WebSocket subprotocol marker that carries the auth token during the handshake

package/dist/esm/protocol.d.ts

@@ -1,4 +1,4 @@
-export type Format = "evm" | "solana" | "leEcdsa" | "leUnsigned";
+export type Format = "evm" | "solana" | "leEcdsa" | "leUnsigned" | "packedEvmEcdsa";
 export type DeliveryFormat = "json" | "binary";
 export type JsonBinaryEncoding = "base64" | "hex";
 export type PriceFeedProperty = "price" | "bestBidPrice" | "bestAskPrice" | "exponent" | "publisherCount" | "confidence" | "fundingRate" | "fundingTimestamp" | "fundingRateInterval" | "marketSession" | "emaPrice" | "emaConfidence" | "feedUpdateTimestamp";
@@ -8,7 +8,8 @@ export type Request = {
     subscriptionId: number;
     priceFeedIds?: number[] | undefined;
     symbols?: string[] | undefined;
-    properties: PriceFeedProperty[];
+    /** Required unless `formats` is `["packedEvmEcdsa"]`, which fixes the properties itself and accepts none. */
+    properties?: PriceFeedProperty[] | undefined;
     formats: Format[];
     deliveryFormat?: DeliveryFormat | undefined;
     jsonBinaryEncoding?: JsonBinaryEncoding | undefined;
@@ -75,6 +76,7 @@ export type Response = {
     solana?: JsonBinaryData | undefined;
     leEcdsa?: JsonBinaryData | undefined;
     leUnsigned?: JsonBinaryData | undefined;
+    packedEvmEcdsa?: JsonBinaryData | undefined;
 };
 export declare const BINARY_UPDATE_FORMAT_MAGIC_LE = 461928307;
 export declare const FORMAT_MAGICS_LE: {
@@ -84,6 +86,10 @@ export declare const FORMAT_MAGICS_LE: {
     LE_UNSIGNED: number;
     SOLANA: number;
 };
+/** The magic at the start of a standard payload serialized as big-endian, read as a big-endian u32. */
+export declare const PAYLOAD_FORMAT_MAGIC_BE = 2479346549;
+/** The magic at the start of a `packedEvmEcdsa` payload: `CEVM`, read as a big-endian u32. */
+export declare const PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE = 1128617549;
 export type AssetType = "crypto" | "fx" | "equity" | "metal" | "rates" | "nav" | "commodity" | "funding-rate" | "eco" | "kalshi";
 export type SymbolsQueryParams = {
     query?: string;
@@ -107,7 +113,8 @@ export type SymbolResponse = {
 export type LatestPriceRequest = {
     priceFeedIds?: number[];
     symbols?: string[];
-    properties: PriceFeedProperty[];
+    /** Required unless `formats` is `["packedEvmEcdsa"]`, which fixes the properties itself and accepts none. */
+    properties?: PriceFeedProperty[];
     formats: Format[];
     jsonBinaryEncoding?: JsonBinaryEncoding;
     parsed?: boolean;
@@ -117,7 +124,8 @@ export type PriceRequest = {
     timestamp: number;
     priceFeedIds?: number[];
     symbols?: string[];
-    properties: PriceFeedProperty[];
+    /** Required unless `formats` is `["packedEvmEcdsa"]`, which fixes the properties itself and accepts none. */
+    properties?: PriceFeedProperty[];
     formats: Format[];
     jsonBinaryEncoding?: JsonBinaryEncoding;
     parsed?: boolean;
@@ -129,6 +137,7 @@ export type JsonUpdate = {
     solana?: JsonBinaryData;
     leEcdsa?: JsonBinaryData;
     leUnsigned?: JsonBinaryData;
+    packedEvmEcdsa?: JsonBinaryData;
 };
 export declare enum CustomSocketClosureCodes {
     CLIENT_TIMEOUT_BUT_RECONNECTING = 4000

package/dist/esm/protocol.mjs

@@ -6,6 +6,8 @@ export const FORMAT_MAGICS_LE = {
     LE_UNSIGNED: 1_499_680_012,
     SOLANA: 2_182_742_457
 };
+/** The magic at the start of a standard payload serialized as big-endian, read as a big-endian u32. */ export const PAYLOAD_FORMAT_MAGIC_BE = 2_479_346_549;
+/** The magic at the start of a `packedEvmEcdsa` payload: `CEVM`, read as a big-endian u32. */ export const PACKED_EVM_PAYLOAD_FORMAT_MAGIC_BE = 1_128_617_549;
 export var CustomSocketClosureCodes = /*#__PURE__*/ function(CustomSocketClosureCodes) {
     CustomSocketClosureCodes[CustomSocketClosureCodes["CLIENT_TIMEOUT_BUT_RECONNECTING"] = 4000] = "CLIENT_TIMEOUT_BUT_RECONNECTING";
     return CustomSocketClosureCodes;

package/package.json

@@ -6,15 +6,15 @@
     "@isaacs/ttlcache": "^2.1.5",
     "buffer": "^6.0.3",
     "isomorphic-ws": "^5.0.0",
-    "ts-log": "^3.0.2",
-    "ws": "^8.21.0"
+    "ts-log": "^3.0.3",
+    "ws": "^8.22.0"
   },
   "description": "Pyth Lazer SDK",
   "devDependencies": {
     "@cprussin/tsconfig": "^5.0.0",
-    "@types/node": "^26.0.0",
-    "@types/ws": "^8.18.1",
-    "typedoc": "^0.28.19"
+    "@types/node": "^26.6.6",
+    "@types/ws": "^8.18.2",
+    "typedoc": "^0.28.20"
   },
   "engines": {
     "node": "^24.0.0"
@@ -154,5 +154,5 @@
   },
   "type": "module",
   "types": "./dist/cjs/index.d.ts",
-  "version": "7.0.0"
+  "version": "7.1.0"
 }