@lidofinance/eth-api-providers 0.0.3

package/README.md

@@ -0,0 +1,29 @@
+# @lidofinance/eth-api-providers
+
+Wraps JsonRpcProvider to track requests to RPC.
+
+## Installation
+
+`yarn add @lidofinance/eth-api-providers`
+
+## Getting started
+
+You just need to pass a few extra parameters to the used JsonRpcProvider, and you will get a patched class.
+
+```ts
+import {
+  providerFactory,
+  StaticJsonRpcBatchProvider,
+} from '@lidofinance/eth-providers';
+import { trackedJsonRpcProvider } from '@lidofinance/eth-api-providers';
+import { registry } from './metrics';
+import { METRICS_PREFIX } from '../config';
+
+export const getStaticRpcBatchProvider = providerFactory(
+  trackedJsonRpcProvider({
+    prefix: METRICS_PREFIX,
+    registry,
+    Provider: StaticJsonRpcBatchProvider,
+  }),
+);
+```

package/dist/index.cjs

@@ -0,0 +1,60 @@
+var $dxMF8$lidofinanceapimetrics = require("@lidofinance/api-metrics");
+
+function $parcel$exportWildcard(dest, source) {
+  Object.keys(source).forEach(function(key) {
+    if (key === 'default' || key === '__esModule' || dest.hasOwnProperty(key)) {
+      return;
+    }
+
+    Object.defineProperty(dest, key, {
+      enumerable: true,
+      get: function get() {
+        return source[key];
+      }
+    });
+  });
+
+  return dest;
+}
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $49914269bebe5bbd$exports = {};
+
+$parcel$export($49914269bebe5bbd$exports, "trackedJsonRpcProvider", () => $49914269bebe5bbd$export$1edad9289b994780);
+
+const $49914269bebe5bbd$export$1edad9289b994780 = ({ prefix: prefix , registry: registry , Provider: Provider  })=>{
+    const { rpcRequestCount: rpcRequestCount , rpcRequestMethods: rpcRequestMethods , rpcResponseTime: rpcResponseTime  } = (0, $dxMF8$lidofinanceapimetrics.rpcMetricsFactory)(prefix, registry);
+    // @ts-expect-error need to investigate how to fix
+    return class extends Provider {
+        async send(method, params) {
+            const chainId = this._network.chainId;
+            const url = this.connection.url;
+            const provider = (0, $dxMF8$lidofinanceapimetrics.getProviderLabel)(url);
+            rpcRequestCount.labels({
+                chainId: chainId,
+                provider: provider
+            }).inc();
+            rpcRequestMethods.labels({
+                method: method
+            }).inc();
+            const responseTime = rpcResponseTime.startTimer();
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const response = await super.send(method, params);
+            responseTime(// Not sure how to get correct status here, but it's probably 2xx, or it throws an error
+            {
+                chainId: chainId,
+                provider: provider,
+                status: "2xx"
+            });
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return response;
+        }
+    };
+};
+
+
+$parcel$exportWildcard(module.exports, $49914269bebe5bbd$exports);
+
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;;;;;;;;;;;;;ACAA;AAUO,MAAM,yCAAsB,GAAG,CAAmC,UACvE,MAAM,CAAA,YACN,QAAQ,CAAA,YACR,QAAQ,CAAA,EAC4B,GAAQ;IAC5C,MAAM,mBAAE,eAAe,CAAA,qBAAE,iBAAiB,CAAA,mBAAE,eAAe,CAAA,EAAE,GAAG,CAAA,GAAA,8CAAiB,CAAA,CAAC,MAAM,EAAE,QAAQ,CAAC;IAEnG,kDAAkD;IAClD,OAAO,cAAc,QAAQ;QAC3B,MAAM,IAAI,CAAC,MAAc,EAAE,MAAiB,EAAE;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG;YAE/B,MAAM,QAAQ,GAAG,CAAA,GAAA,6CAAgB,CAAA,CAAC,GAAG,CAAC;YACtC,eAAe,CAAC,MAAM,CAAC;yBAAE,OAAO;0BAAE,QAAQ;aAAE,CAAC,CAAC,GAAG,EAAE;YACnD,iBAAiB,CAAC,MAAM,CAAC;wBAAE,MAAM;aAAE,CAAC,CAAC,GAAG,EAAE;YAC1C,MAAM,YAAY,GAAG,eAAe,CAAC,UAAU,EAAE;YAEjD,mEAAmE;YACnE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAEjD,YAAY,CACV,wFAAwF;YACxF;yBAAE,OAAO;0BAAE,QAAQ;gBAAE,MAAM,EAAE,KAAK;aAAE,CACrC;YAED,+DAA+D;YAC/D,OAAO,QAAQ,CAAA;SAChB;KACF,CAAA;CACF;;ADxCD","sources":["packages/eth/api/providers/src/index.ts","packages/eth/api/providers/src/trackedJsonRpcProvider.ts"],"sourcesContent":["export * from './trackedJsonRpcProvider'\n","import { JsonRpcProvider } from '@ethersproject/providers'\nimport { getProviderLabel, rpcMetricsFactory } from '@lidofinance/api-metrics'\nimport { Registry } from 'prom-client'\n\nexport type TrackedJsonRpcProviderParameters<P extends typeof JsonRpcProvider> = {\n  prefix: string\n  registry: Registry\n  Provider: P\n}\n\nexport const trackedJsonRpcProvider = <P extends typeof JsonRpcProvider>({\n  prefix,\n  registry,\n  Provider,\n}: TrackedJsonRpcProviderParameters<P>): P => {\n  const { rpcRequestCount, rpcRequestMethods, rpcResponseTime } = rpcMetricsFactory(prefix, registry)\n\n  // @ts-expect-error need to investigate how to fix\n  return class extends Provider {\n    async send(method: string, params: unknown[]) {\n      const chainId = this._network.chainId\n      const url = this.connection.url\n\n      const provider = getProviderLabel(url)\n      rpcRequestCount.labels({ chainId, provider }).inc()\n      rpcRequestMethods.labels({ method }).inc()\n      const responseTime = rpcResponseTime.startTimer()\n\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n      const response = await super.send(method, params)\n\n      responseTime(\n        // Not sure how to get correct status here, but it's probably 2xx, or it throws an error\n        { chainId, provider, status: '2xx' },\n      )\n\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n      return response\n    }\n  }\n}\n"],"names":[],"version":3,"file":"index.cjs.map","sourceRoot":"../../../../../"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { JsonRpcProvider } from "@ethersproject/providers";
+import { Registry } from "prom-client";
+export type TrackedJsonRpcProviderParameters<P extends typeof JsonRpcProvider> = {
+    prefix: string;
+    registry: Registry;
+    Provider: P;
+};
+export const trackedJsonRpcProvider: <P extends typeof JsonRpcProvider>({ prefix, registry, Provider, }: TrackedJsonRpcProviderParameters<P>) => P;
+
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"mappings":";;AAIA,6CAA6C,CAAC,SAAS,sBAAsB,IAAI;IAC/E,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;IAClB,QAAQ,EAAE,CAAC,CAAA;CACZ,CAAA;AAED,OAAO,MAAM,qIA8BZ,CAAA","sources":["packages/eth/api/providers/src/src/trackedJsonRpcProvider.ts","packages/eth/api/providers/src/src/index.ts","packages/eth/api/providers/src/index.ts"],"sourcesContent":[null,null,"export * from './trackedJsonRpcProvider'\n"],"names":[],"version":3,"file":"index.d.ts.map","sourceRoot":"../../../../../"}

package/dist/index.mjs

@@ -0,0 +1,44 @@
+import {rpcMetricsFactory as $6lHim$rpcMetricsFactory, getProviderLabel as $6lHim$getProviderLabel} from "@lidofinance/api-metrics";
+
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $61abdbc1f5acaa33$exports = {};
+
+$parcel$export($61abdbc1f5acaa33$exports, "trackedJsonRpcProvider", () => $61abdbc1f5acaa33$export$1edad9289b994780);
+
+const $61abdbc1f5acaa33$export$1edad9289b994780 = ({ prefix: prefix , registry: registry , Provider: Provider  })=>{
+    const { rpcRequestCount: rpcRequestCount , rpcRequestMethods: rpcRequestMethods , rpcResponseTime: rpcResponseTime  } = (0, $6lHim$rpcMetricsFactory)(prefix, registry);
+    // @ts-expect-error need to investigate how to fix
+    return class extends Provider {
+        async send(method, params) {
+            const chainId = this._network.chainId;
+            const url = this.connection.url;
+            const provider = (0, $6lHim$getProviderLabel)(url);
+            rpcRequestCount.labels({
+                chainId: chainId,
+                provider: provider
+            }).inc();
+            rpcRequestMethods.labels({
+                method: method
+            }).inc();
+            const responseTime = rpcResponseTime.startTimer();
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const response = await super.send(method, params);
+            responseTime(// Not sure how to get correct status here, but it's probably 2xx, or it throws an error
+            {
+                chainId: chainId,
+                provider: provider,
+                status: "2xx"
+            });
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return response;
+        }
+    };
+};
+
+
+
+
+export {$61abdbc1f5acaa33$export$1edad9289b994780 as trackedJsonRpcProvider};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;ACAA;AAUO,MAAM,yCAAsB,GAAG,CAAmC,UACvE,MAAM,CAAA,YACN,QAAQ,CAAA,YACR,QAAQ,CAAA,EAC4B,GAAQ;IAC5C,MAAM,mBAAE,eAAe,CAAA,qBAAE,iBAAiB,CAAA,mBAAE,eAAe,CAAA,EAAE,GAAG,CAAA,GAAA,wBAAiB,CAAA,CAAC,MAAM,EAAE,QAAQ,CAAC;IAEnG,kDAAkD;IAClD,OAAO,cAAc,QAAQ;QAC3B,MAAM,IAAI,CAAC,MAAc,EAAE,MAAiB,EAAE;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG;YAE/B,MAAM,QAAQ,GAAG,CAAA,GAAA,uBAAgB,CAAA,CAAC,GAAG,CAAC;YACtC,eAAe,CAAC,MAAM,CAAC;yBAAE,OAAO;0BAAE,QAAQ;aAAE,CAAC,CAAC,GAAG,EAAE;YACnD,iBAAiB,CAAC,MAAM,CAAC;wBAAE,MAAM;aAAE,CAAC,CAAC,GAAG,EAAE;YAC1C,MAAM,YAAY,GAAG,eAAe,CAAC,UAAU,EAAE;YAEjD,mEAAmE;YACnE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAEjD,YAAY,CACV,wFAAwF;YACxF;yBAAE,OAAO;0BAAE,QAAQ;gBAAE,MAAM,EAAE,KAAK;aAAE,CACrC;YAED,+DAA+D;YAC/D,OAAO,QAAQ,CAAA;SAChB;KACF,CAAA;CACF;;ADxCD","sources":["packages/eth/api/providers/src/index.ts","packages/eth/api/providers/src/trackedJsonRpcProvider.ts"],"sourcesContent":["export * from './trackedJsonRpcProvider'\n","import { JsonRpcProvider } from '@ethersproject/providers'\nimport { getProviderLabel, rpcMetricsFactory } from '@lidofinance/api-metrics'\nimport { Registry } from 'prom-client'\n\nexport type TrackedJsonRpcProviderParameters<P extends typeof JsonRpcProvider> = {\n  prefix: string\n  registry: Registry\n  Provider: P\n}\n\nexport const trackedJsonRpcProvider = <P extends typeof JsonRpcProvider>({\n  prefix,\n  registry,\n  Provider,\n}: TrackedJsonRpcProviderParameters<P>): P => {\n  const { rpcRequestCount, rpcRequestMethods, rpcResponseTime } = rpcMetricsFactory(prefix, registry)\n\n  // @ts-expect-error need to investigate how to fix\n  return class extends Provider {\n    async send(method: string, params: unknown[]) {\n      const chainId = this._network.chainId\n      const url = this.connection.url\n\n      const provider = getProviderLabel(url)\n      rpcRequestCount.labels({ chainId, provider }).inc()\n      rpcRequestMethods.labels({ method }).inc()\n      const responseTime = rpcResponseTime.startTimer()\n\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n      const response = await super.send(method, params)\n\n      responseTime(\n        // Not sure how to get correct status here, but it's probably 2xx, or it throws an error\n        { chainId, provider, status: '2xx' },\n      )\n\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n      return response\n    }\n  }\n}\n"],"names":[],"version":3,"file":"index.mjs.map","sourceRoot":"../../../../../"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@lidofinance/eth-api-providers",
+  "description": "Wraps JsonRpcProvider to track requests to RPC",
+  "repository": "git@github.com:lidofinance/lido-ui-blocks.git",
+  "license": "MIT",
+  "version": "0.0.3",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">= 16"
+  },
+  "source": "./src/index.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "parcel build",
+    "format": "prettier --check src",
+    "format:fix": "yarn format --write",
+    "types": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@lidofinance/api-metrics": "0.0.3",
+    "@ethersproject/logger": "^5.5.2",
+    "@ethersproject/networks": "^5.5.0",
+    "@ethersproject/properties": "^5.5.0",
+    "@ethersproject/providers": "^5.5.0",
+    "prom-client": "^14.0.0"
+  },
+  "devDependencies": {
+    "@lidofinance/api-metrics": "0.0.3",
+    "@lidofinance/config-prettier": "0.0.1",
+    "@ethersproject/logger": "^5.5.2",
+    "@ethersproject/networks": "^5.5.0",
+    "@ethersproject/properties": "^5.5.0",
+    "@ethersproject/providers": "^5.5.0",
+    "prom-client": "^14.0.0"
+  }
+}