@polkadot/rpc-core 10.9.1 → 10.10.1

package/bundle.d.ts

@@ -1,5 +1,6 @@
 import type { ProviderInterface } from '@polkadot/rpc-provider/types';
 import type { AnyNumber, DefinitionRpc, DefinitionRpcExt, DefinitionRpcSub, Registry } from '@polkadot/types/types';
+import type { RpcCoreStats } from './types/index.js';
 export { packageInfo } from './packageInfo.js';
 export * from './util/index.js';
 interface Options {
@@ -53,6 +54,10 @@ export declare class RpcCore {
      * @description Manually disconnect from the attached provider
      */
     disconnect(): Promise<void>;
+    /**
+     * @description Returns the underlying core stats, including those from teh provider
+     */
+    get stats(): RpcCoreStats | undefined;
     /**
      * @description Sets a registry swap (typically from Api)
      */

package/bundle.js

@@ -56,9 +56,10 @@ export class RpcCore {
      */
     constructor(instanceId, registry, { isPedantic = true, provider, userRpc = {} }) {
         this.__internal__storageCache = new Map();
+        this.__internal__storageCacheHits = 0;
+        this.__internal__storageCacheSize = 0;
         this.mapping = new Map();
         this.sections = [];
-        // eslint-disable-next-line @typescript-eslint/unbound-method
         if (!provider || !isFunction(provider.send)) {
             throw new Error('Expected Provider to API create');
         }
@@ -90,6 +91,21 @@ export class RpcCore {
     disconnect() {
         return this.provider.disconnect();
     }
+    /**
+     * @description Returns the underlying core stats, including those from teh provider
+     */
+    get stats() {
+        const stats = this.provider.stats;
+        return stats
+            ? {
+                ...stats,
+                core: {
+                    cacheHits: this.__internal__storageCacheHits,
+                    cacheSize: this.__internal__storageCacheSize
+                }
+            }
+            : undefined;
+    }
     /**
      * @description Sets a registry swap (typically from Api)
      */
@@ -337,6 +353,7 @@ export class RpcCore {
         if (isNotFound && withCache) {
             const cached = this.__internal__storageCache.get(hexKey);
             if (cached) {
+                this.__internal__storageCacheHits++;
                 return cached;
             }
         }
@@ -352,6 +369,7 @@ export class RpcCore {
         // clearing of it, so very long running processes (not just a couple of hours, longer)
         // will increase memory beyond what is allowed.
         this.__internal__storageCache.set(hexKey, codec);
+        this.__internal__storageCacheSize++;
         return codec;
     }
     _newType(registry, blockHash, key, input, isEmpty, entryIndex = -1) {

package/cjs/bundle.js

@@ -61,9 +61,10 @@ class RpcCore {
      */
     constructor(instanceId, registry, { isPedantic = true, provider, userRpc = {} }) {
         this.__internal__storageCache = new Map();
+        this.__internal__storageCacheHits = 0;
+        this.__internal__storageCacheSize = 0;
         this.mapping = new Map();
         this.sections = [];
-        // eslint-disable-next-line @typescript-eslint/unbound-method
         if (!provider || !(0, util_1.isFunction)(provider.send)) {
             throw new Error('Expected Provider to API create');
         }
@@ -95,6 +96,21 @@ class RpcCore {
     disconnect() {
         return this.provider.disconnect();
     }
+    /**
+     * @description Returns the underlying core stats, including those from teh provider
+     */
+    get stats() {
+        const stats = this.provider.stats;
+        return stats
+            ? {
+                ...stats,
+                core: {
+                    cacheHits: this.__internal__storageCacheHits,
+                    cacheSize: this.__internal__storageCacheSize
+                }
+            }
+            : undefined;
+    }
     /**
      * @description Sets a registry swap (typically from Api)
      */
@@ -342,6 +358,7 @@ class RpcCore {
         if (isNotFound && withCache) {
             const cached = this.__internal__storageCache.get(hexKey);
             if (cached) {
+                this.__internal__storageCacheHits++;
                 return cached;
             }
         }
@@ -357,6 +374,7 @@ class RpcCore {
         // clearing of it, so very long running processes (not just a couple of hours, longer)
         // will increase memory beyond what is allowed.
         this.__internal__storageCache.set(hexKey, codec);
+        this.__internal__storageCacheSize++;
         return codec;
     }
     _newType(registry, blockHash, key, input, isEmpty, entryIndex = -1) {

package/cjs/packageInfo.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageInfo = void 0;
-exports.packageInfo = { name: '@polkadot/rpc-core', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '10.9.1' };
+exports.packageInfo = { name: '@polkadot/rpc-core', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '10.10.1' };

package/package.json

@@ -18,7 +18,7 @@
     "./cjs/detectPackage.js"
   ],
   "type": "module",
-  "version": "10.9.1",
+  "version": "10.10.1",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -109,11 +109,11 @@
     }
   },
   "dependencies": {
-    "@polkadot/rpc-augment": "10.9.1",
-    "@polkadot/rpc-provider": "10.9.1",
-    "@polkadot/types": "10.9.1",
-    "@polkadot/util": "^12.3.1",
+    "@polkadot/rpc-augment": "10.10.1",
+    "@polkadot/rpc-provider": "10.10.1",
+    "@polkadot/types": "10.10.1",
+    "@polkadot/util": "^12.5.1",
     "rxjs": "^7.8.1",
-    "tslib": "^2.5.3"
+    "tslib": "^2.6.2"
   }
 }

package/packageInfo.js

@@ -1 +1 @@
-export const packageInfo = { name: '@polkadot/rpc-core', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '10.9.1' };
+export const packageInfo = { name: '@polkadot/rpc-core', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '10.10.1' };

package/types/base.d.ts

@@ -1,4 +1,5 @@
 import type { Observable } from 'rxjs';
+import type { ProviderInterface } from '@polkadot/rpc-provider/types';
 import type { AnyFunction, Codec, DefinitionRpc } from '@polkadot/types/types';
 export interface RpcInterfaceMethod {
     <T extends Codec>(...params: unknown[]): Observable<T>;
@@ -9,3 +10,13 @@ export type AugmentedRpc<F extends AnyFunction> = F & {
     raw: <T>(...params: Parameters<F>) => Observable<T>;
     meta: DefinitionRpc;
 };
+/** Stats from the rpc-core layer, including the provider stats */
+export interface RpcCoreStats extends NonNullable<ProviderInterface['stats']> {
+    /** Internal stats for the rpc-core layer */
+    core: {
+        /** The number of values retrieved from the core cache */
+        cacheHits: number;
+        /** The number of entries in the core cache */
+        cacheSize: number;
+    };
+}