@pythnetwork/hermes-client 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -99,8 +99,8 @@ export declare class HermesClient {
99
99
  getPriceUpdatesStream(ids: HexString[], options?: {
100
100
  encoding?: EncodingType;
101
101
  parsed?: boolean;
102
- allow_unordered?: boolean;
103
- benchmarks_only?: boolean;
102
+ allowUnordered?: boolean;
103
+ benchmarksOnly?: boolean;
104
104
  }): Promise<EventSource>;
105
105
  private appendUrlSearchParams;
106
106
  }
@@ -1 +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;AAGxB,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,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,GACA,OAAO,CAAC,WAAW,CAAC;IAavB,OAAO,CAAC,qBAAqB;CAU9B"}
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"}
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.HermesClient = void 0;
7
7
  const eventsource_1 = __importDefault(require("eventsource"));
8
8
  const zodSchemas_1 = require("./zodSchemas");
9
+ const utils_1 = require("./utils");
9
10
  const DEFAULT_TIMEOUT = 5000;
10
11
  const DEFAULT_HTTP_RETRIES = 3;
11
12
  class HermesClient {
@@ -134,7 +135,8 @@ class HermesClient {
134
135
  url.searchParams.append("ids[]", id);
135
136
  });
136
137
  if (options) {
137
- this.appendUrlSearchParams(url, options);
138
+ const transformedOptions = (0, utils_1.camelToSnakeCaseObject)(options);
139
+ this.appendUrlSearchParams(url, transformedOptions);
138
140
  }
139
141
  return new eventsource_1.default(url.toString());
140
142
  }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=HermesClient.d.ts.map
@@ -40,7 +40,12 @@ async function run() {
40
40
  const priceUpdates = await connection.getLatestPriceUpdates(priceIds);
41
41
  console.log(priceUpdates);
42
42
  // Streaming price updates
43
- const eventSource = await connection.getPriceUpdatesStream(priceIds);
43
+ const eventSource = await connection.getPriceUpdatesStream(priceIds, {
44
+ encoding: "hex",
45
+ parsed: true,
46
+ allowUnordered: true,
47
+ benchmarksOnly: true,
48
+ });
44
49
  eventSource.onmessage = (event) => {
45
50
  console.log("Received price update:", event.data);
46
51
  };
package/lib/utils.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export declare function camelToSnakeCaseObject(obj: Record<string, string | boolean>): Record<string, string | boolean>;
2
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAIA,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GACpC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAMlC"}
package/lib/utils.js ADDED
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.camelToSnakeCaseObject = void 0;
4
+ function camelToSnakeCase(str) {
5
+ return str.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
6
+ }
7
+ function camelToSnakeCaseObject(obj) {
8
+ const result = {};
9
+ Object.keys(obj).forEach((key) => {
10
+ result[camelToSnakeCase(key)] = obj[key];
11
+ });
12
+ return result;
13
+ }
14
+ exports.camelToSnakeCaseObject = camelToSnakeCaseObject;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pythnetwork/hermes-client",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Pyth Hermes Client",
5
5
  "author": {
6
6
  "name": "Pyth Data Association"
@@ -25,12 +25,12 @@
25
25
  "build": "tsc",
26
26
  "generate-hermes-api-types": "openapi-zod-client https://hermes.pyth.network/docs/openapi.json --output src/zodSchemas.ts && prettier --write src/zodSchemas.ts",
27
27
  "check-hermes-api-types": "git diff --exit-code src/zodSchemas.ts",
28
- "example": "npm run build && node lib/examples/HermesClient.js",
28
+ "example": "pnpm run build && node lib/examples/HermesClient.js",
29
29
  "format": "prettier --write \"src/**/*.ts\"",
30
30
  "lint": "eslint src/",
31
- "prepublishOnly": "npm run build && npm test && npm run lint",
32
- "preversion": "npm run lint",
33
- "version": "npm run format && git add -A src"
31
+ "prepublishOnly": "pnpm run build && pnpm test && pnpm run lint",
32
+ "preversion": "pnpm run lint",
33
+ "version": "pnpm run format && git add -A src"
34
34
  },
35
35
  "keywords": [
36
36
  "pyth",
@@ -40,6 +40,7 @@
40
40
  "devDependencies": {
41
41
  "@types/eventsource": "^1.1.15",
42
42
  "@types/jest": "^29.4.0",
43
+ "@types/node": "^20.14.2",
43
44
  "@types/yargs": "^17.0.10",
44
45
  "@typescript-eslint/eslint-plugin": "^5.21.0",
45
46
  "@typescript-eslint/parser": "^5.21.0",
@@ -52,8 +53,9 @@
52
53
  "yargs": "^17.4.1"
53
54
  },
54
55
  "dependencies": {
56
+ "@zodios/core": "^10.9.6",
55
57
  "eventsource": "^2.0.2",
56
58
  "zod": "^3.23.8"
57
59
  },
58
- "gitHead": "113f8797625be44370b31c73b22bd115a3e167aa"
60
+ "gitHead": "adf0b3ba67b4742ddb4d3ff01059cb891c7fea89"
59
61
  }