@pythnetwork/pyth-lazer-sdk 0.1.0 → 0.1.2

package/dist/cjs/client.d.ts

@@ -0,0 +1,21 @@
+import WebSocket from "isomorphic-ws";
+import { type ParsedPayload, type Request, type Response } from "./protocol.js";
+export type BinaryResponse = {
+    subscriptionId: number;
+    evm?: Buffer | undefined;
+    solana?: Buffer | undefined;
+    parsed?: ParsedPayload | undefined;
+};
+export type JsonOrBinaryResponse = {
+    type: "json";
+    value: Response;
+} | {
+    type: "binary";
+    value: BinaryResponse;
+};
+export declare class PythLazerClient {
+    ws: WebSocket;
+    constructor(url: string, token: string);
+    addMessageListener(handler: (event: JsonOrBinaryResponse) => void): void;
+    send(request: Request): void;
+}

package/dist/cjs/client.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PythLazerClient = void 0;
+const isomorphic_ws_1 = __importDefault(require("isomorphic-ws"));
+const protocol_js_1 = require("./protocol.js");
+const UINT16_NUM_BYTES = 2;
+const UINT32_NUM_BYTES = 4;
+const UINT64_NUM_BYTES = 8;
+class PythLazerClient {
+    ws;
+    constructor(url, token) {
+        const finalUrl = new URL(url);
+        finalUrl.searchParams.append("ACCESS_TOKEN", token);
+        this.ws = new isomorphic_ws_1.default(finalUrl);
+    }
+    addMessageListener(handler) {
+        this.ws.addEventListener("message", (event) => {
+            if (typeof event.data == "string") {
+                handler({
+                    type: "json",
+                    value: JSON.parse(event.data),
+                });
+            }
+            else if (Buffer.isBuffer(event.data)) {
+                let pos = 0;
+                const magic = event.data
+                    .subarray(pos, pos + UINT32_NUM_BYTES)
+                    .readUint32BE();
+                pos += UINT32_NUM_BYTES;
+                if (magic != protocol_js_1.BINARY_UPDATE_FORMAT_MAGIC) {
+                    throw new Error("binary update format magic mismatch");
+                }
+                // TODO: some uint64 values may not be representable as Number.
+                const subscriptionId = Number(event.data.subarray(pos, pos + UINT64_NUM_BYTES).readBigInt64BE());
+                pos += UINT64_NUM_BYTES;
+                const value = { subscriptionId };
+                while (pos < event.data.length) {
+                    const len = event.data
+                        .subarray(pos, pos + UINT16_NUM_BYTES)
+                        .readUint16BE();
+                    pos += UINT16_NUM_BYTES;
+                    const magic = event.data
+                        .subarray(pos, pos + UINT32_NUM_BYTES)
+                        .readUint32BE();
+                    if (magic == protocol_js_1.EVM_FORMAT_MAGIC) {
+                        value.evm = event.data.subarray(pos, pos + len);
+                    }
+                    else if (magic == protocol_js_1.SOLANA_FORMAT_MAGIC_BE) {
+                        value.solana = event.data.subarray(pos, pos + len);
+                    }
+                    else if (magic == protocol_js_1.PARSED_FORMAT_MAGIC) {
+                        value.parsed = JSON.parse(event.data.subarray(pos + UINT32_NUM_BYTES, pos + len).toString());
+                    }
+                    else {
+                        throw new Error("unknown magic: " + magic.toString());
+                    }
+                    pos += len;
+                }
+                handler({ type: "binary", value });
+            }
+            else {
+                throw new TypeError("unexpected event data type");
+            }
+        });
+    }
+    send(request) {
+        this.ws.send(JSON.stringify(request));
+    }
+}
+exports.PythLazerClient = PythLazerClient;

package/dist/cjs/ed25519.d.ts

@@ -0,0 +1,2 @@
+import { TransactionInstruction } from "@solana/web3.js";
+export declare const createEd25519Instruction: (message: Buffer, instructionIndex: number, startingOffset: number) => TransactionInstruction;

package/dist/cjs/ed25519.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEd25519Instruction = void 0;
+const BufferLayout = __importStar(require("@solana/buffer-layout"));
+const web3_js_1 = require("@solana/web3.js");
+const ED25519_INSTRUCTION_LEN = 16;
+const SIGNATURE_LEN = 64;
+const PUBKEY_LEN = 32;
+const MAGIC_LEN = 4;
+const MESSAGE_SIZE_LEN = 2;
+const ED25519_INSTRUCTION_LAYOUT = BufferLayout.struct([
+    BufferLayout.u8("numSignatures"),
+    BufferLayout.u8("padding"),
+    BufferLayout.u16("signatureOffset"),
+    BufferLayout.u16("signatureInstructionIndex"),
+    BufferLayout.u16("publicKeyOffset"),
+    BufferLayout.u16("publicKeyInstructionIndex"),
+    BufferLayout.u16("messageDataOffset"),
+    BufferLayout.u16("messageDataSize"),
+    BufferLayout.u16("messageInstructionIndex"),
+]);
+const createEd25519Instruction = (message, instructionIndex, startingOffset) => {
+    const signatureOffset = startingOffset + MAGIC_LEN;
+    const publicKeyOffset = signatureOffset + SIGNATURE_LEN;
+    const messageDataSizeOffset = publicKeyOffset + PUBKEY_LEN;
+    const messageDataOffset = messageDataSizeOffset + MESSAGE_SIZE_LEN;
+    const messageDataSize = message.readUInt16LE(messageDataSizeOffset - startingOffset);
+    const instructionData = Buffer.alloc(ED25519_INSTRUCTION_LEN);
+    ED25519_INSTRUCTION_LAYOUT.encode({
+        numSignatures: 1,
+        padding: 0,
+        signatureOffset,
+        signatureInstructionIndex: instructionIndex,
+        publicKeyOffset,
+        publicKeyInstructionIndex: instructionIndex,
+        messageDataOffset,
+        messageDataSize: messageDataSize,
+        messageInstructionIndex: instructionIndex,
+    }, instructionData);
+    return new web3_js_1.TransactionInstruction({
+        keys: [],
+        programId: web3_js_1.Ed25519Program.programId,
+        data: instructionData,
+    });
+};
+exports.createEd25519Instruction = createEd25519Instruction;

package/dist/cjs/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./client.js";
+export * from "./protocol.js";
+export * from "./ed25519.js";

package/dist/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client.js"), exports);
+__exportStar(require("./protocol.js"), exports);
+__exportStar(require("./ed25519.js"), exports);

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/cjs/protocol.d.ts

@@ -0,0 +1,57 @@
+export type Chain = "evm" | "solana";
+export type DeliveryFormat = "json" | "binary";
+export type JsonBinaryEncoding = "base64" | "hex";
+export type PriceFeedProperty = "price" | "bestBidPrice" | "bestAskPrice";
+export type Channel = "real_time" | "fixed_rate@50ms" | "fixed_rate@200ms";
+export type Request = {
+    type: "subscribe";
+    subscriptionId: number;
+    priceFeedIds: number[];
+    properties: PriceFeedProperty[];
+    chains: Chain[];
+    deliveryFormat?: DeliveryFormat;
+    jsonBinaryEncoding?: JsonBinaryEncoding;
+    parsed?: boolean;
+    channel: Channel;
+} | {
+    type: "unsubscribe";
+    subscriptionId: number;
+};
+export type ParsedFeedPayload = {
+    priceFeedId: number;
+    price?: string | undefined;
+    bestBidPrice?: string | undefined;
+    bestAskPrice?: string | undefined;
+};
+export type ParsedPayload = {
+    timestampUs: string;
+    priceFeeds: ParsedFeedPayload[];
+};
+export type JsonBinaryData = {
+    encoding: JsonBinaryEncoding;
+    data: string;
+};
+export type Response = {
+    type: "error";
+    error: string;
+} | {
+    type: "subscribed";
+    subscriptionId: number;
+} | {
+    type: "unsubscribed";
+    subscriptionId: number;
+} | {
+    type: "subscriptionError";
+    subscriptionId: number;
+    error: string;
+} | {
+    type: "streamUpdated";
+    subscriptionId: number;
+    parsed?: ParsedPayload | undefined;
+    evm?: JsonBinaryData | undefined;
+    solana?: JsonBinaryData | undefined;
+};
+export declare const BINARY_UPDATE_FORMAT_MAGIC = 1937213467;
+export declare const PARSED_FORMAT_MAGIC = 2584795844;
+export declare const EVM_FORMAT_MAGIC = 706910618;
+export declare const SOLANA_FORMAT_MAGIC_BE = 3103857282;

package/dist/cjs/protocol.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOLANA_FORMAT_MAGIC_BE = exports.EVM_FORMAT_MAGIC = exports.PARSED_FORMAT_MAGIC = exports.BINARY_UPDATE_FORMAT_MAGIC = void 0;
+exports.BINARY_UPDATE_FORMAT_MAGIC = 1_937_213_467;
+exports.PARSED_FORMAT_MAGIC = 2_584_795_844;
+exports.EVM_FORMAT_MAGIC = 706_910_618;
+exports.SOLANA_FORMAT_MAGIC_BE = 3_103_857_282;

package/dist/esm/client.d.ts

@@ -0,0 +1,21 @@
+import WebSocket from "isomorphic-ws";
+import { type ParsedPayload, type Request, type Response } from "./protocol.js";
+export type BinaryResponse = {
+    subscriptionId: number;
+    evm?: Buffer | undefined;
+    solana?: Buffer | undefined;
+    parsed?: ParsedPayload | undefined;
+};
+export type JsonOrBinaryResponse = {
+    type: "json";
+    value: Response;
+} | {
+    type: "binary";
+    value: BinaryResponse;
+};
+export declare class PythLazerClient {
+    ws: WebSocket;
+    constructor(url: string, token: string);
+    addMessageListener(handler: (event: JsonOrBinaryResponse) => void): void;
+    send(request: Request): void;
+}

package/dist/esm/client.js

@@ -0,0 +1,66 @@
+import WebSocket from "isomorphic-ws";
+import { BINARY_UPDATE_FORMAT_MAGIC, EVM_FORMAT_MAGIC, PARSED_FORMAT_MAGIC, SOLANA_FORMAT_MAGIC_BE, } from "./protocol.js";
+const UINT16_NUM_BYTES = 2;
+const UINT32_NUM_BYTES = 4;
+const UINT64_NUM_BYTES = 8;
+export class PythLazerClient {
+    ws;
+    constructor(url, token) {
+        const finalUrl = new URL(url);
+        finalUrl.searchParams.append("ACCESS_TOKEN", token);
+        this.ws = new WebSocket(finalUrl);
+    }
+    addMessageListener(handler) {
+        this.ws.addEventListener("message", (event) => {
+            if (typeof event.data == "string") {
+                handler({
+                    type: "json",
+                    value: JSON.parse(event.data),
+                });
+            }
+            else if (Buffer.isBuffer(event.data)) {
+                let pos = 0;
+                const magic = event.data
+                    .subarray(pos, pos + UINT32_NUM_BYTES)
+                    .readUint32BE();
+                pos += UINT32_NUM_BYTES;
+                if (magic != BINARY_UPDATE_FORMAT_MAGIC) {
+                    throw new Error("binary update format magic mismatch");
+                }
+                // TODO: some uint64 values may not be representable as Number.
+                const subscriptionId = Number(event.data.subarray(pos, pos + UINT64_NUM_BYTES).readBigInt64BE());
+                pos += UINT64_NUM_BYTES;
+                const value = { subscriptionId };
+                while (pos < event.data.length) {
+                    const len = event.data
+                        .subarray(pos, pos + UINT16_NUM_BYTES)
+                        .readUint16BE();
+                    pos += UINT16_NUM_BYTES;
+                    const magic = event.data
+                        .subarray(pos, pos + UINT32_NUM_BYTES)
+                        .readUint32BE();
+                    if (magic == EVM_FORMAT_MAGIC) {
+                        value.evm = event.data.subarray(pos, pos + len);
+                    }
+                    else if (magic == SOLANA_FORMAT_MAGIC_BE) {
+                        value.solana = event.data.subarray(pos, pos + len);
+                    }
+                    else if (magic == PARSED_FORMAT_MAGIC) {
+                        value.parsed = JSON.parse(event.data.subarray(pos + UINT32_NUM_BYTES, pos + len).toString());
+                    }
+                    else {
+                        throw new Error("unknown magic: " + magic.toString());
+                    }
+                    pos += len;
+                }
+                handler({ type: "binary", value });
+            }
+            else {
+                throw new TypeError("unexpected event data type");
+            }
+        });
+    }
+    send(request) {
+        this.ws.send(JSON.stringify(request));
+    }
+}

package/dist/esm/ed25519.d.ts

@@ -0,0 +1,2 @@
+import { TransactionInstruction } from "@solana/web3.js";
+export declare const createEd25519Instruction: (message: Buffer, instructionIndex: number, startingOffset: number) => TransactionInstruction;

package/dist/esm/ed25519.js

@@ -0,0 +1,42 @@
+import * as BufferLayout from "@solana/buffer-layout";
+import { Ed25519Program, TransactionInstruction } from "@solana/web3.js";
+const ED25519_INSTRUCTION_LEN = 16;
+const SIGNATURE_LEN = 64;
+const PUBKEY_LEN = 32;
+const MAGIC_LEN = 4;
+const MESSAGE_SIZE_LEN = 2;
+const ED25519_INSTRUCTION_LAYOUT = BufferLayout.struct([
+    BufferLayout.u8("numSignatures"),
+    BufferLayout.u8("padding"),
+    BufferLayout.u16("signatureOffset"),
+    BufferLayout.u16("signatureInstructionIndex"),
+    BufferLayout.u16("publicKeyOffset"),
+    BufferLayout.u16("publicKeyInstructionIndex"),
+    BufferLayout.u16("messageDataOffset"),
+    BufferLayout.u16("messageDataSize"),
+    BufferLayout.u16("messageInstructionIndex"),
+]);
+export const createEd25519Instruction = (message, instructionIndex, startingOffset) => {
+    const signatureOffset = startingOffset + MAGIC_LEN;
+    const publicKeyOffset = signatureOffset + SIGNATURE_LEN;
+    const messageDataSizeOffset = publicKeyOffset + PUBKEY_LEN;
+    const messageDataOffset = messageDataSizeOffset + MESSAGE_SIZE_LEN;
+    const messageDataSize = message.readUInt16LE(messageDataSizeOffset - startingOffset);
+    const instructionData = Buffer.alloc(ED25519_INSTRUCTION_LEN);
+    ED25519_INSTRUCTION_LAYOUT.encode({
+        numSignatures: 1,
+        padding: 0,
+        signatureOffset,
+        signatureInstructionIndex: instructionIndex,
+        publicKeyOffset,
+        publicKeyInstructionIndex: instructionIndex,
+        messageDataOffset,
+        messageDataSize: messageDataSize,
+        messageInstructionIndex: instructionIndex,
+    }, instructionData);
+    return new TransactionInstruction({
+        keys: [],
+        programId: Ed25519Program.programId,
+        data: instructionData,
+    });
+};

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./client.js";
+export * from "./protocol.js";
+export * from "./ed25519.js";

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+export * from "./client.js";
+export * from "./protocol.js";
+export * from "./ed25519.js";

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/dist/esm/protocol.d.ts

@@ -0,0 +1,57 @@
+export type Chain = "evm" | "solana";
+export type DeliveryFormat = "json" | "binary";
+export type JsonBinaryEncoding = "base64" | "hex";
+export type PriceFeedProperty = "price" | "bestBidPrice" | "bestAskPrice";
+export type Channel = "real_time" | "fixed_rate@50ms" | "fixed_rate@200ms";
+export type Request = {
+    type: "subscribe";
+    subscriptionId: number;
+    priceFeedIds: number[];
+    properties: PriceFeedProperty[];
+    chains: Chain[];
+    deliveryFormat?: DeliveryFormat;
+    jsonBinaryEncoding?: JsonBinaryEncoding;
+    parsed?: boolean;
+    channel: Channel;
+} | {
+    type: "unsubscribe";
+    subscriptionId: number;
+};
+export type ParsedFeedPayload = {
+    priceFeedId: number;
+    price?: string | undefined;
+    bestBidPrice?: string | undefined;
+    bestAskPrice?: string | undefined;
+};
+export type ParsedPayload = {
+    timestampUs: string;
+    priceFeeds: ParsedFeedPayload[];
+};
+export type JsonBinaryData = {
+    encoding: JsonBinaryEncoding;
+    data: string;
+};
+export type Response = {
+    type: "error";
+    error: string;
+} | {
+    type: "subscribed";
+    subscriptionId: number;
+} | {
+    type: "unsubscribed";
+    subscriptionId: number;
+} | {
+    type: "subscriptionError";
+    subscriptionId: number;
+    error: string;
+} | {
+    type: "streamUpdated";
+    subscriptionId: number;
+    parsed?: ParsedPayload | undefined;
+    evm?: JsonBinaryData | undefined;
+    solana?: JsonBinaryData | undefined;
+};
+export declare const BINARY_UPDATE_FORMAT_MAGIC = 1937213467;
+export declare const PARSED_FORMAT_MAGIC = 2584795844;
+export declare const EVM_FORMAT_MAGIC = 706910618;
+export declare const SOLANA_FORMAT_MAGIC_BE = 3103857282;

package/dist/esm/protocol.js

@@ -0,0 +1,4 @@
+export const BINARY_UPDATE_FORMAT_MAGIC = 1_937_213_467;
+export const PARSED_FORMAT_MAGIC = 2_584_795_844;
+export const EVM_FORMAT_MAGIC = 706_910_618;
+export const SOLANA_FORMAT_MAGIC_BE = 3_103_857_282;

package/package.json

@@ -1,21 +1,33 @@
 {
   "name": "@pythnetwork/pyth-lazer-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Pyth Lazer SDK",
   "publishConfig": {
     "access": "public"
   },
   "files": [
-    "lib/**/*"
+    "dist/**/*"
   ],
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "exports": {
+    "import": {
+      "types": "./dist/esm/index.d.ts",
+      "default": "./dist/esm/index.js"
+    },
+    "require": {
+      "types": "./dist/cjs/index.d.ts",
+      "default": "./dist/cjs/index.js"
+    }
+  },
   "scripts": {
-    "build:cjs": "tsc --project tsconfig.json --verbatimModuleSyntax false --module commonjs --outDir ./dist/cjs && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
-    "build:esm": "tsc --project tsconfig.json --outDir ./dist/esm && echo '{\"type\":\"module\"}' > dist/esm/package.json",
+    "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 .",
+    "test:lint": "eslint .",
+    "test:types": "tsc",
     "example": "node --loader ts-node/esm examples/index.js",
-    "test": "pnpm run test:lint && pnpm run build:cjs && pnpm run build:esm",
     "doc": "typedoc --out docs/typedoc src",
-    "test:lint": "eslint .",
-    "fix:lint": "eslint --fix .",
     "publish": "pnpm run script -- publish"
   },
   "devDependencies": {
@@ -48,8 +60,10 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
+    "@solana/buffer-layout": "^4.0.1",
+    "@solana/web3.js": "^1.98.0",
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.18.0"
   },
-  "gitHead": "44d691a97e316ba111fc6329c5e71d76f7a7c986"
+  "gitHead": "57670ca732de0be3ed7926f38f4853f01cd816fa"
 }