rename proto fields and re-generate

Author: darunrs

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

@@ -30,7 +30,7 @@
     "fix:format": "prettier --write .",
     "example": "node --loader ts-node/esm examples/index.js",
     "doc": "typedoc --out docs/typedoc src",
-    "publish": "pnpm run script -- publish",
+    "publish": "pnpm run prebuild && pnpm run script -- publish",
     "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",
     "prebuild": "rm -rf ./src/generated && npm run proto-codegen"
   },

lazer/sdk/js/src/generated/proto.d.ts

@@ -3,209 +3,209 @@ import Long = require("long");
 /** Namespace pyth_lazer_transaction. */
 export namespace pyth_lazer_transaction {
 
-    /** Properties of a PublisherUpdatePayload. */
-    interface IPublisherUpdatePayload {
+    /** Properties of a PublisherUpdate. */
+    interface IPublisherUpdate {
 
-        /** PublisherUpdatePayload updates */
-        updates?: (pyth_lazer_transaction.IPublisherUpdate[]|null);
+        /** PublisherUpdate updates */
+        updates?: (pyth_lazer_transaction.IFeedUpdate[]|null);
 
-        /** PublisherUpdatePayload batchTimestampUs */
+        /** PublisherUpdate batchTimestampUs */
         batchTimestampUs?: (number|Long|null);
     }
 
-    /** Represents a PublisherUpdatePayload. */
-    class PublisherUpdatePayload implements IPublisherUpdatePayload {
+    /** Represents a PublisherUpdate. */
+    class PublisherUpdate implements IPublisherUpdate {
 
         /**
-         * Constructs a new PublisherUpdatePayload.
+         * Constructs a new PublisherUpdate.
          * @param [properties] Properties to set
          */
-        constructor(properties?: pyth_lazer_transaction.IPublisherUpdatePayload);
+        constructor(properties?: pyth_lazer_transaction.IPublisherUpdate);
 
-        /** PublisherUpdatePayload updates. */
-        public updates: pyth_lazer_transaction.IPublisherUpdate[];
+        /** PublisherUpdate updates. */
+        public updates: pyth_lazer_transaction.IFeedUpdate[];
 
-        /** PublisherUpdatePayload batchTimestampUs. */
+        /** PublisherUpdate batchTimestampUs. */
         public batchTimestampUs: (number|Long);
 
         /**
-         * Creates a new PublisherUpdatePayload instance using the specified properties.
+         * Creates a new PublisherUpdate instance using the specified properties.
          * @param [properties] Properties to set
-         * @returns PublisherUpdatePayload instance
+         * @returns PublisherUpdate instance
          */
-        public static create(properties?: pyth_lazer_transaction.IPublisherUpdatePayload): pyth_lazer_transaction.PublisherUpdatePayload;
+        public static create(properties?: pyth_lazer_transaction.IPublisherUpdate): pyth_lazer_transaction.PublisherUpdate;
 
         /**
-         * Encodes the specified PublisherUpdatePayload message. Does not implicitly {@link pyth_lazer_transaction.PublisherUpdatePayload.verify|verify} messages.
-         * @param message PublisherUpdatePayload message or plain object to encode
+         * Encodes the specified PublisherUpdate message. Does not implicitly {@link pyth_lazer_transaction.PublisherUpdate.verify|verify} messages.
+         * @param message PublisherUpdate message or plain object to encode
          * @param [writer] Writer to encode to
          * @returns Writer
          */
-        public static encode(message: pyth_lazer_transaction.IPublisherUpdatePayload, writer?: $protobuf.Writer): $protobuf.Writer;
+        public static encode(message: pyth_lazer_transaction.IPublisherUpdate, writer?: $protobuf.Writer): $protobuf.Writer;
 
         /**
-         * Encodes the specified PublisherUpdatePayload message, length delimited. Does not implicitly {@link pyth_lazer_transaction.PublisherUpdatePayload.verify|verify} messages.
-         * @param message PublisherUpdatePayload message or plain object to encode
+         * Encodes the specified PublisherUpdate message, length delimited. Does not implicitly {@link pyth_lazer_transaction.PublisherUpdate.verify|verify} messages.
+         * @param message PublisherUpdate message or plain object to encode
          * @param [writer] Writer to encode to
          * @returns Writer
          */
-        public static encodeDelimited(message: pyth_lazer_transaction.IPublisherUpdatePayload, writer?: $protobuf.Writer): $protobuf.Writer;
+        public static encodeDelimited(message: pyth_lazer_transaction.IPublisherUpdate, writer?: $protobuf.Writer): $protobuf.Writer;
 
         /**
-         * Decodes a PublisherUpdatePayload message from the specified reader or buffer.
+         * Decodes a PublisherUpdate message from the specified reader or buffer.
          * @param reader Reader or buffer to decode from
          * @param [length] Message length if known beforehand
-         * @returns PublisherUpdatePayload
+         * @returns PublisherUpdate
          * @throws {Error} If the payload is not a reader or valid buffer
          * @throws {$protobuf.util.ProtocolError} If required fields are missing
          */
-        public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): pyth_lazer_transaction.PublisherUpdatePayload;
+        public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): pyth_lazer_transaction.PublisherUpdate;
 
         /**
-         * Decodes a PublisherUpdatePayload message from the specified reader or buffer, length delimited.
+         * Decodes a PublisherUpdate message from the specified reader or buffer, length delimited.
          * @param reader Reader or buffer to decode from
-         * @returns PublisherUpdatePayload
+         * @returns PublisherUpdate
          * @throws {Error} If the payload is not a reader or valid buffer
          * @throws {$protobuf.util.ProtocolError} If required fields are missing
          */
-        public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): pyth_lazer_transaction.PublisherUpdatePayload;
+        public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): pyth_lazer_transaction.PublisherUpdate;
 
         /**
-         * Verifies a PublisherUpdatePayload message.
+         * Verifies a PublisherUpdate message.
          * @param message Plain object to verify
          * @returns `null` if valid, otherwise the reason why it is not
          */
         public static verify(message: { [k: string]: any }): (string|null);
 
         /**
-         * Creates a PublisherUpdatePayload message from a plain object. Also converts values to their respective internal types.
+         * Creates a PublisherUpdate message from a plain object. Also converts values to their respective internal types.
          * @param object Plain object
-         * @returns PublisherUpdatePayload
+         * @returns PublisherUpdate
          */
-        public static fromObject(object: { [k: string]: any }): pyth_lazer_transaction.PublisherUpdatePayload;
+        public static fromObject(object: { [k: string]: any }): pyth_lazer_transaction.PublisherUpdate;
 
         /**
-         * Creates a plain object from a PublisherUpdatePayload message. Also converts values to other types if specified.
-         * @param message PublisherUpdatePayload
+         * Creates a plain object from a PublisherUpdate message. Also converts values to other types if specified.
+         * @param message PublisherUpdate
          * @param [options] Conversion options
          * @returns Plain object
          */
-        public static toObject(message: pyth_lazer_transaction.PublisherUpdatePayload, options?: $protobuf.IConversionOptions): { [k: string]: any };
+        public static toObject(message: pyth_lazer_transaction.PublisherUpdate, options?: $protobuf.IConversionOptions): { [k: string]: any };
 
         /**
-         * Converts this PublisherUpdatePayload to JSON.
+         * Converts this PublisherUpdate to JSON.
          * @returns JSON object
          */
         public toJSON(): { [k: string]: any };
 
         /**
-         * Gets the default type url for PublisherUpdatePayload
+         * Gets the default type url for PublisherUpdate
          * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
          * @returns The default type url
          */
         public static getTypeUrl(typeUrlPrefix?: string): string;
     }
 
-    /** Properties of a PublisherUpdate. */
-    interface IPublisherUpdate {
+    /** Properties of a FeedUpdate. */
+    interface IFeedUpdate {
 
-        /** PublisherUpdate priceUpdateV1 */
+        /** FeedUpdate priceUpdateV1 */
         priceUpdateV1?: (pyth_lazer_transaction.IPriceUpdateV1|null);
 
-        /** PublisherUpdate fundingRateUpdateV1 */
+        /** FeedUpdate fundingRateUpdateV1 */
         fundingRateUpdateV1?: (pyth_lazer_transaction.IFundingRateUpdateV1|null);
     }
 
-    /** Represents a PublisherUpdate. */
-    class PublisherUpdate implements IPublisherUpdate {
+    /** Represents a FeedUpdate. */
+    class FeedUpdate implements IFeedUpdate {
 
         /**
-         * Constructs a new PublisherUpdate.
+         * Constructs a new FeedUpdate.
          * @param [properties] Properties to set
          */
-        constructor(properties?: pyth_lazer_transaction.IPublisherUpdate);
+        constructor(properties?: pyth_lazer_transaction.IFeedUpdate);
 
-        /** PublisherUpdate priceUpdateV1. */
+        /** FeedUpdate priceUpdateV1. */
         public priceUpdateV1?: (pyth_lazer_transaction.IPriceUpdateV1|null);
 
-        /** PublisherUpdate fundingRateUpdateV1. */
+        /** FeedUpdate fundingRateUpdateV1. */
         public fundingRateUpdateV1?: (pyth_lazer_transaction.IFundingRateUpdateV1|null);
 
-        /** PublisherUpdate update. */
+        /** FeedUpdate update. */
         public update?: ("priceUpdateV1"|"fundingRateUpdateV1");
 
         /**
-         * Creates a new PublisherUpdate instance using the specified properties.
+         * Creates a new FeedUpdate instance using the specified properties.
          * @param [properties] Properties to set
-         * @returns PublisherUpdate instance
+         * @returns FeedUpdate instance
          */
-        public static create(properties?: pyth_lazer_transaction.IPublisherUpdate): pyth_lazer_transaction.PublisherUpdate;
+        public static create(properties?: pyth_lazer_transaction.IFeedUpdate): pyth_lazer_transaction.FeedUpdate;
 
         /**
-         * Encodes the specified PublisherUpdate message. Does not implicitly {@link pyth_lazer_transaction.PublisherUpdate.verify|verify} messages.
-         * @param message PublisherUpdate message or plain object to encode
+         * Encodes the specified FeedUpdate message. Does not implicitly {@link pyth_lazer_transaction.FeedUpdate.verify|verify} messages.
+         * @param message FeedUpdate message or plain object to encode
          * @param [writer] Writer to encode to
          * @returns Writer
          */
-        public static encode(message: pyth_lazer_transaction.IPublisherUpdate, writer?: $protobuf.Writer): $protobuf.Writer;
+        public static encode(message: pyth_lazer_transaction.IFeedUpdate, writer?: $protobuf.Writer): $protobuf.Writer;
 
         /**
-         * Encodes the specified PublisherUpdate message, length delimited. Does not implicitly {@link pyth_lazer_transaction.PublisherUpdate.verify|verify} messages.
-         * @param message PublisherUpdate message or plain object to encode
+         * Encodes the specified FeedUpdate message, length delimited. Does not implicitly {@link pyth_lazer_transaction.FeedUpdate.verify|verify} messages.
+         * @param message FeedUpdate message or plain object to encode
          * @param [writer] Writer to encode to
          * @returns Writer
          */
-        public static encodeDelimited(message: pyth_lazer_transaction.IPublisherUpdate, writer?: $protobuf.Writer): $protobuf.Writer;
+        public static encodeDelimited(message: pyth_lazer_transaction.IFeedUpdate, writer?: $protobuf.Writer): $protobuf.Writer;
 
         /**
-         * Decodes a PublisherUpdate message from the specified reader or buffer.
+         * Decodes a FeedUpdate message from the specified reader or buffer.
          * @param reader Reader or buffer to decode from
          * @param [length] Message length if known beforehand
-         * @returns PublisherUpdate
+         * @returns FeedUpdate
          * @throws {Error} If the payload is not a reader or valid buffer
          * @throws {$protobuf.util.ProtocolError} If required fields are missing
          */
-        public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): pyth_lazer_transaction.PublisherUpdate;
+        public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): pyth_lazer_transaction.FeedUpdate;
 
         /**
-         * Decodes a PublisherUpdate message from the specified reader or buffer, length delimited.
+         * Decodes a FeedUpdate message from the specified reader or buffer, length delimited.
          * @param reader Reader or buffer to decode from
-         * @returns PublisherUpdate
+         * @returns FeedUpdate
          * @throws {Error} If the payload is not a reader or valid buffer
          * @throws {$protobuf.util.ProtocolError} If required fields are missing
          */
-        public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): pyth_lazer_transaction.PublisherUpdate;
+        public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): pyth_lazer_transaction.FeedUpdate;
 
         /**
-         * Verifies a PublisherUpdate message.
+         * Verifies a FeedUpdate message.
          * @param message Plain object to verify
          * @returns `null` if valid, otherwise the reason why it is not
          */
         public static verify(message: { [k: string]: any }): (string|null);
 
         /**
-         * Creates a PublisherUpdate message from a plain object. Also converts values to their respective internal types.
+         * Creates a FeedUpdate message from a plain object. Also converts values to their respective internal types.
          * @param object Plain object
-         * @returns PublisherUpdate
+         * @returns FeedUpdate
          */
-        public static fromObject(object: { [k: string]: any }): pyth_lazer_transaction.PublisherUpdate;
+        public static fromObject(object: { [k: string]: any }): pyth_lazer_transaction.FeedUpdate;
 
         /**
-         * Creates a plain object from a PublisherUpdate message. Also converts values to other types if specified.
-         * @param message PublisherUpdate
+         * Creates a plain object from a FeedUpdate message. Also converts values to other types if specified.
+         * @param message FeedUpdate
          * @param [options] Conversion options
          * @returns Plain object
          */
-        public static toObject(message: pyth_lazer_transaction.PublisherUpdate, options?: $protobuf.IConversionOptions): { [k: string]: any };
+        public static toObject(message: pyth_lazer_transaction.FeedUpdate, options?: $protobuf.IConversionOptions): { [k: string]: any };
 
         /**
-         * Converts this PublisherUpdate to JSON.
+         * Converts this FeedUpdate to JSON.
          * @returns JSON object
          */
         public toJSON(): { [k: string]: any };
 
         /**
-         * Gets the default type url for PublisherUpdate
+         * Gets the default type url for FeedUpdate
          * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
          * @returns The default type url
          */
@@ -215,8 +215,8 @@ export namespace pyth_lazer_transaction {
     /** Properties of a PriceUpdateV1. */
     interface IPriceUpdateV1 {
 
-        /** PriceUpdateV1 priceFeedId */
-        priceFeedId?: (number|null);
+        /** PriceUpdateV1 feedId */
+        feedId?: (number|null);
 
         /** PriceUpdateV1 sourceTimestampUs */
         sourceTimestampUs?: (number|Long|null);
@@ -243,8 +243,8 @@ export namespace pyth_lazer_transaction {
          */
         constructor(properties?: pyth_lazer_transaction.IPriceUpdateV1);
 
-        /** PriceUpdateV1 priceFeedId. */
-        public priceFeedId: number;
+        /** PriceUpdateV1 feedId. */
+        public feedId: number;
 
         /** PriceUpdateV1 sourceTimestampUs. */
         public sourceTimestampUs: (number|Long);
@@ -342,8 +342,8 @@ export namespace pyth_lazer_transaction {
     /** Properties of a FundingRateUpdateV1. */
     interface IFundingRateUpdateV1 {
 
-        /** FundingRateUpdateV1 priceFeedId */
-        priceFeedId?: (number|null);
+        /** FundingRateUpdateV1 feedId */
+        feedId?: (number|null);
 
         /** FundingRateUpdateV1 sourceTimestampUs */
         sourceTimestampUs?: (number|Long|null);
@@ -367,8 +367,8 @@ export namespace pyth_lazer_transaction {
          */
         constructor(properties?: pyth_lazer_transaction.IFundingRateUpdateV1);
 
-        /** FundingRateUpdateV1 priceFeedId. */
-        public priceFeedId: number;
+        /** FundingRateUpdateV1 feedId. */
+        public feedId: number;
 
         /** FundingRateUpdateV1 sourceTimestampUs. */
         public sourceTimestampUs: (number|Long);
@@ -578,7 +578,7 @@ export namespace pyth_lazer_transaction {
     interface ILazerTransaction {
 
         /** LazerTransaction publisherUpdates */
-        publisherUpdates?: (pyth_lazer_transaction.IPublisherUpdatePayload|null);
+        publisherUpdates?: (pyth_lazer_transaction.IPublisherUpdate|null);
     }
 
     /** Represents a LazerTransaction. */
@@ -591,10 +591,10 @@ export namespace pyth_lazer_transaction {
         constructor(properties?: pyth_lazer_transaction.ILazerTransaction);
 
         /** LazerTransaction publisherUpdates. */
-        public publisherUpdates?: (pyth_lazer_transaction.IPublisherUpdatePayload|null);
+        public publisherUpdates?: (pyth_lazer_transaction.IPublisherUpdate|null);
 
-        /** LazerTransaction transaction. */
-        public transaction?: "publisherUpdates";
+        /** LazerTransaction payload. */
+        public payload?: "publisherUpdates";
 
         /**
          * Creates a new LazerTransaction instance using the specified properties.