@pythnetwork/hermes-client 2.1.0 → 3.1.0

package/dist/cjs/hermes-client.cjs

@@ -18,6 +18,7 @@ class HermesClient {
     timeout;
     httpRetries;
     headers;
+    accessToken;
     /**
    * Constructs a new Connection.
    *
@@ -28,9 +29,15 @@ class HermesClient {
         this.timeout = config?.timeout ?? DEFAULT_TIMEOUT;
         this.httpRetries = config?.httpRetries ?? DEFAULT_HTTP_RETRIES;
         this.headers = config?.headers ?? {};
+        this.accessToken = config?.accessToken;
     }
     async httpRequest(url, schema, options, retries = this.httpRetries, backoff = 100 + Math.floor(Math.random() * 100)) {
         try {
+            // Build auth headers if access token is provided
+            const authHeaders = {};
+            if (this.accessToken !== undefined) {
+                authHeaders.Authorization = `Bearer ${this.accessToken}`;
+            }
             const response = await fetch(url, {
                 ...options,
                 signal: AbortSignal.any([
@@ -40,6 +47,7 @@ class HermesClient {
                     AbortSignal.timeout(this.timeout)
                 ]),
                 headers: {
+                    ...authHeaders,
                     ...this.headers,
                     ...options?.headers
                 }
@@ -168,41 +176,22 @@ class HermesClient {
             const transformedOptions = (0, _utils.camelToSnakeCaseObject)(options);
             this.appendUrlSearchParams(url, transformedOptions);
         }
+        // Build auth headers for SSE fetch
+        const authHeaders = {};
+        if (this.accessToken !== undefined) {
+            authHeaders.Authorization = `Bearer ${this.accessToken}`;
+        }
         return new _eventsource.EventSource(url.toString(), {
             fetch: (input, init)=>fetch(input, {
                     ...init,
                     headers: {
                         ...init?.headers,
+                        ...authHeaders,
                         ...this.headers
                     }
                 })
         });
     }
-    /**
-   * Fetch the latest TWAP (time weighted average price) for a set of price feed IDs.
-   * This endpoint can be customized by specifying the encoding type and whether the results should also return the calculated TWAP using the options object.
-   * This will throw an error if there is a network problem or the price service returns a non-ok response.
-   *
-   * @param ids - Array of hex-encoded price feed IDs for which updates are requested.
-   * @param window_seconds - The time window in seconds over which to calculate the TWAP, ending at the current time.
-   *  For example, a value of 300 would return the most recent 5 minute TWAP. Must be greater than 0 and less than or equal to 600 seconds (10 minutes).
-   * @param options - Optional parameters:
-   *        - encoding: Encoding type. If specified, return the TWAP binary data in the encoding specified by the encoding parameter. Default is hex.
-   *        - parsed: Boolean to specify if the calculated TWAP should be included in the response. Default is false.
-   *        - ignoreInvalidPriceIds: Boolean to specify if invalid price IDs should be ignored instead of returning an error. Default is false.
-   *
-   * @returns TwapsResponse object containing the latest TWAPs.
-   */ async getLatestTwaps(ids, window_seconds, options, fetchOptions) {
-        const url = this.buildURL(`updates/twap/${window_seconds.toString()}/latest`);
-        for (const id of ids){
-            url.searchParams.append("ids[]", id);
-        }
-        if (options) {
-            const transformedOptions = (0, _utils.camelToSnakeCaseObject)(options);
-            this.appendUrlSearchParams(url, transformedOptions);
-        }
-        return this.httpRequest(url.toString(), _zodSchemas.schemas.TwapsResponse, fetchOptions);
-    }
     appendUrlSearchParams(url, params) {
         for (const [key, value] of Object.entries(params)){
             // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition

package/dist/cjs/hermes-client.d.ts

@@ -7,7 +7,6 @@ export type EncodingType = z.infer<typeof schemas.EncodingType>;
 export type PriceFeedMetadata = z.infer<typeof schemas.PriceFeedMetadata>;
 export type PriceIdInput = z.infer<typeof schemas.PriceIdInput>;
 export type PriceUpdate = z.infer<typeof schemas.PriceUpdate>;
-export type TwapsResponse = z.infer<typeof schemas.TwapsResponse>;
 export type PublisherCaps = z.infer<typeof schemas.LatestPublisherStakeCapsUpdateDataResponse>;
 export type UnixTimestamp = number;
 export type DurationInSeconds = number;
@@ -26,12 +25,20 @@ export type HermesClientConfig = {
      * Optional headers to be included in every request.
      */
     headers?: HeadersInit;
+    /**
+     * Optional API access token for authentication.
+     * When provided, this token will be included in all requests either:
+     * - As a Bearer token in the Authorization header (for HTTP requests)
+     * - As an ACCESS_TOKEN query parameter (for WebSocket/SSE connections)
+     */
+    accessToken?: string;
 };
 export declare class HermesClient {
     private baseURL;
     private timeout;
     private httpRetries;
     private headers;
+    private accessToken;
     /**
      * Constructs a new Connection.
      *
@@ -133,26 +140,6 @@ export declare class HermesClient {
         benchmarksOnly?: boolean;
         ignoreInvalidPriceIds?: boolean;
     }): Promise<EventSource>;
-    /**
-     * Fetch the latest TWAP (time weighted average price) for a set of price feed IDs.
-     * This endpoint can be customized by specifying the encoding type and whether the results should also return the calculated TWAP using the options object.
-     * This will throw an error if there is a network problem or the price service returns a non-ok response.
-     *
-     * @param ids - Array of hex-encoded price feed IDs for which updates are requested.
-     * @param window_seconds - The time window in seconds over which to calculate the TWAP, ending at the current time.
-     *  For example, a value of 300 would return the most recent 5 minute TWAP. Must be greater than 0 and less than or equal to 600 seconds (10 minutes).
-     * @param options - Optional parameters:
-     *        - encoding: Encoding type. If specified, return the TWAP binary data in the encoding specified by the encoding parameter. Default is hex.
-     *        - parsed: Boolean to specify if the calculated TWAP should be included in the response. Default is false.
-     *        - ignoreInvalidPriceIds: Boolean to specify if invalid price IDs should be ignored instead of returning an error. Default is false.
-     *
-     * @returns TwapsResponse object containing the latest TWAPs.
-     */
-    getLatestTwaps(ids: HexString[], window_seconds: number, options?: {
-        encoding?: EncodingType;
-        parsed?: boolean;
-        ignoreInvalidPriceIds?: boolean;
-    }, fetchOptions?: RequestInit): Promise<TwapsResponse>;
     private appendUrlSearchParams;
     private buildURL;
 }

package/dist/cjs/utils.cjs

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */ "use strict";
+"use strict";
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
@@ -8,7 +8,7 @@ Object.defineProperty(exports, "camelToSnakeCaseObject", {
         return camelToSnakeCaseObject;
     }
 });
-function camelToSnakeCase(str) {
+/* eslint-disable @typescript-eslint/no-non-null-assertion */ function camelToSnakeCase(str) {
     return str.replaceAll(/[A-Z]/g, (letter)=>`_${letter.toLowerCase()}`);
 }
 function camelToSnakeCaseObject(obj) {

package/dist/cjs/zodSchemas.cjs

@@ -30,7 +30,9 @@ const AssetType = _zod.z.enum([
     "crypto_redemption_rate",
     "commodities",
     "crypto_index",
-    "crypto_nav"
+    "crypto_nav",
+    "eco",
+    "kalshi"
 ]);
 const asset_type = AssetType.nullish();
 const RpcPriceIdentifier = _zod.z.string();
@@ -79,17 +81,6 @@ const LatestPublisherStakeCapsUpdateDataResponse = _zod.z.object({
     binary: BinaryUpdate,
     parsed: _zod.z.array(ParsedPublisherStakeCapsUpdate).nullish()
 }).passthrough();
-const ParsedPriceFeedTwap = _zod.z.object({
-    down_slots_ratio: _zod.z.string(),
-    end_timestamp: _zod.z.number().int(),
-    id: RpcPriceIdentifier,
-    start_timestamp: _zod.z.number().int(),
-    twap: RpcPrice
-}).passthrough();
-const TwapsResponse = _zod.z.object({
-    binary: BinaryUpdate,
-    parsed: _zod.z.array(ParsedPriceFeedTwap).nullish()
-}).passthrough();
 const schemas = {
     AssetType,
     asset_type,
@@ -104,9 +95,7 @@ const schemas = {
     PriceUpdate,
     ParsedPublisherStakeCap,
     ParsedPublisherStakeCapsUpdate,
-    LatestPublisherStakeCapsUpdateDataResponse,
-    ParsedPriceFeedTwap,
-    TwapsResponse
+    LatestPublisherStakeCapsUpdateDataResponse
 };
 const endpoints = (0, _core.makeApi)([
     {
@@ -296,53 +285,6 @@ Clients should implement reconnection logic to maintain continuous price updates
             }
         ],
         response: LatestPublisherStakeCapsUpdateDataResponse
-    },
-    {
-        method: "get",
-        path: "/v2/updates/twap/:window_seconds/latest",
-        alias: "latest_twaps",
-        description: `Get the latest TWAP by price feed id with a custom time window.
-
-Given a collection of price feed ids, retrieve the latest Pyth TWAP price for each price feed.`,
-        requestFormat: "json",
-        parameters: [
-            {
-                name: "window_seconds",
-                type: "Path",
-                schema: _zod.z.number().int().gte(0)
-            },
-            {
-                name: "ids[]",
-                type: "Query",
-                schema: _zod.z.array(PriceIdInput)
-            },
-            {
-                name: "encoding",
-                type: "Query",
-                schema: _zod.z.enum([
-                    "hex",
-                    "base64"
-                ]).optional()
-            },
-            {
-                name: "parsed",
-                type: "Query",
-                schema: _zod.z.boolean().optional()
-            },
-            {
-                name: "ignore_invalid_price_ids",
-                type: "Query",
-                schema: _zod.z.boolean().optional()
-            }
-        ],
-        response: TwapsResponse,
-        errors: [
-            {
-                status: 404,
-                description: `Price ids not found`,
-                schema: _zod.z.void()
-            }
-        ]
     }
 ]);
 const api = new _core.Zodios(endpoints);