@pythnetwork/hermes-client 2.1.0 → 3.1.0

package/dist/esm/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/esm/hermes-client.mjs

@@ -8,6 +8,7 @@ export class HermesClient {
     timeout;
     httpRetries;
     headers;
+    accessToken;
     /**
    * Constructs a new Connection.
    *
@@ -18,9 +19,15 @@ export 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([
@@ -30,6 +37,7 @@ export class HermesClient {
                     AbortSignal.timeout(this.timeout)
                 ]),
                 headers: {
+                    ...authHeaders,
                     ...this.headers,
                     ...options?.headers
                 }
@@ -158,41 +166,22 @@ export class HermesClient {
             const transformedOptions = 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(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 = camelToSnakeCaseObject(options);
-            this.appendUrlSearchParams(url, transformedOptions);
-        }
-        return this.httpRequest(url.toString(), schemas.TwapsResponse, fetchOptions);
-    }
     appendUrlSearchParams(url, params) {
         for (const [key, value] of Object.entries(params)){
             // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition