@pythnetwork/hermes-client 1.0.2 → 1.0.4

package/lib/HermesClient.d.ts

@@ -20,11 +20,16 @@ export type HermesClientConfig = {
      * it will timeout regardless of the retries at the configured `timeout` time.
      */
     httpRetries?: number;
+    /**
+     * Optional headers to be included in every request.
+     */
+    headers?: HeadersInit;
 };
 export declare class HermesClient {
     private baseURL;
     private timeout;
     private httpRetries;
+    private headers;
     /**
      * Constructs a new Connection.
      *

package/lib/HermesClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HermesClient.d.ts","sourceRoot":"","sources":["../src/HermesClient.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;AAC1D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAC1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AAChE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAC1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AAChE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;AAK9D,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,kBAAkB,GAAG;IAE/B,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,WAAW,CAAS;IAE5B;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB;YAM3C,WAAW;IAqCzB;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,CAAC,EAAE;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAWhC;;;;;;;;;;;OAWG;IACG,qBAAqB,CACzB,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,GACA,OAAO,CAAC,WAAW,CAAC;IAavB;;;;;;;;;;;;OAYG;IACG,0BAA0B,CAC9B,WAAW,EAAE,aAAa,EAC1B,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,GACA,OAAO,CAAC,WAAW,CAAC;IAavB;;;;;;;;;;;;;;OAcG;IACG,qBAAqB,CACzB,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,GACA,OAAO,CAAC,WAAW,CAAC;IAcvB,OAAO,CAAC,qBAAqB;CAU9B"}
+{"version":3,"file":"HermesClient.d.ts","sourceRoot":"","sources":["../src/HermesClient.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;AAC1D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAC1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AAChE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAC1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AAChE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;AAK9D,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,kBAAkB,GAAG;IAE/B,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,OAAO,CAAc;IAE7B;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB;YAO3C,WAAW;IAyCzB;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,CAAC,EAAE;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAWhC;;;;;;;;;;;OAWG;IACG,qBAAqB,CACzB,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,GACA,OAAO,CAAC,WAAW,CAAC;IAavB;;;;;;;;;;;;OAYG;IACG,0BAA0B,CAC9B,WAAW,EAAE,aAAa,EAC1B,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,GACA,OAAO,CAAC,WAAW,CAAC;IAavB;;;;;;;;;;;;;;OAcG;IACG,qBAAqB,CACzB,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,GACA,OAAO,CAAC,WAAW,CAAC;IAcvB,OAAO,CAAC,qBAAqB;CAU9B"}

package/lib/HermesClient.js

@@ -13,6 +13,7 @@ class HermesClient {
     baseURL;
     timeout;
     httpRetries;
+    headers;
     /**
      * Constructs a new Connection.
      *
@@ -23,12 +24,17 @@ class HermesClient {
         this.baseURL = endpoint;
         this.timeout = config?.timeout ?? DEFAULT_TIMEOUT;
         this.httpRetries = config?.httpRetries ?? DEFAULT_HTTP_RETRIES;
+        this.headers = config?.headers ?? {};
     }
     async httpRequest(url, schema, options, retries = this.httpRetries, backoff = 100 + Math.floor(Math.random() * 100), // Adding randomness to the initial backoff to avoid "thundering herd" scenario where a lot of clients that get kicked off all at the same time (say some script or something) and fail to connect all retry at exactly the same time too
     externalAbortController) {
         const controller = externalAbortController ?? new AbortController();
         const { signal } = controller;
-        options = { ...options, signal }; // Merge any existing options with the signal
+        options = {
+            ...options,
+            signal,
+            headers: { ...this.headers, ...options?.headers },
+        }; // Merge any existing options with the signal and headers
         // Set a timeout to abort the request if it takes too long
         const timeout = setTimeout(() => controller.abort(), this.timeout);
         try {
@@ -63,7 +69,7 @@ class HermesClient {
      * @returns Array of PriceFeedMetadata objects.
      */
     async getPriceFeeds(options) {
-        const url = new URL("/v2/price_feeds", this.baseURL);
+        const url = new URL("v2/price_feeds", this.baseURL);
         if (options) {
             this.appendUrlSearchParams(url, options);
         }
@@ -82,7 +88,7 @@ class HermesClient {
      * @returns PriceUpdate object containing the latest updates.
      */
     async getLatestPriceUpdates(ids, options) {
-        const url = new URL(`${this.baseURL}/v2/updates/price/latest`);
+        const url = new URL("v2/updates/price/latest", this.baseURL);
         for (const id of ids) {
             url.searchParams.append("ids[]", id);
         }
@@ -105,7 +111,7 @@ class HermesClient {
      * @returns PriceUpdate object containing the updates at the specified timestamp.
      */
     async getPriceUpdatesAtTimestamp(publishTime, ids, options) {
-        const url = new URL(`${this.baseURL}/v2/updates/price/${publishTime}`);
+        const url = new URL(`v2/updates/price/${publishTime}`, this.baseURL);
         for (const id of ids) {
             url.searchParams.append("ids[]", id);
         }
@@ -130,7 +136,7 @@ class HermesClient {
      * @returns An EventSource instance for receiving streaming updates.
      */
     async getPriceUpdatesStream(ids, options) {
-        const url = new URL("/v2/updates/price/stream", this.baseURL);
+        const url = new URL("v2/updates/price/stream", this.baseURL);
         ids.forEach((id) => {
             url.searchParams.append("ids[]", id);
         });
@@ -138,7 +144,7 @@ class HermesClient {
             const transformedOptions = (0, utils_1.camelToSnakeCaseObject)(options);
             this.appendUrlSearchParams(url, transformedOptions);
         }
-        return new eventsource_1.default(url.toString());
+        return new eventsource_1.default(url.toString(), { headers: this.headers });
     }
     appendUrlSearchParams(url, params) {
         Object.entries(params).forEach(([key, value]) => {

package/lib/examples/HermesClient.js

@@ -27,8 +27,25 @@ const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
     "parse-numbers": false,
 })
     .parseSync();
+/**
+ * Extracts the endpoint and basic authorization headers from a given URL string.
+ *
+ * @param {string} urlString - The URL string containing the endpoint and optional basic auth credentials.
+ * @returns {{ endpoint: string; headers: HeadersInit }} An object containing the endpoint URL and headers.
+ */
+function extractBasicAuthorizationHeadersFromUrl(urlString) {
+    const url = new URL(urlString);
+    const headers = {};
+    if (url.username && url.password) {
+        headers["Authorization"] = `Basic ${btoa(`${url.username}:${url.password}`)}`;
+        url.username = "";
+        url.password = "";
+    }
+    return { endpoint: url.toString(), headers };
+}
 async function run() {
-    const connection = new HermesClient_1.HermesClient(argv.endpoint);
+    const { endpoint, headers } = extractBasicAuthorizationHeadersFromUrl(argv.endpoint);
+    const connection = new HermesClient_1.HermesClient(endpoint, { headers });
     const priceIds = argv.priceIds;
     // Get price feeds
     const priceFeeds = await connection.getPriceFeeds({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/hermes-client",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Pyth Hermes Client",
   "author": {
     "name": "Pyth Data Association"
@@ -57,5 +57,5 @@
     "eventsource": "^2.0.2",
     "zod": "^3.23.8"
   },
-  "gitHead": "adf0b3ba67b4742ddb4d3ff01059cb891c7fea89"
+  "gitHead": "07a7767ca5718c839f55702439af08a6889f682b"
 }