@polkadot/rpc-core 14.0.1 → 14.2.1

package/bundle.d.ts

@@ -79,5 +79,6 @@ export declare class RpcCore {
     private _formatStorageData;
     private _formatStorageSet;
     private _formatStorageSetEntry;
+    private _setToCache;
     private _newType;
 }

package/bundle.js

@@ -1,4 +1,5 @@
 import { Observable, publishReplay, refCount } from 'rxjs';
+import { DEFAULT_CAPACITY, LRUCache } from '@polkadot/rpc-provider';
 import { rpcDefinitions } from '@polkadot/types';
 import { hexToU8a, isFunction, isNull, isUndefined, lazyMethod, logger, memoize, objectSpread, u8aConcat, u8aToU8a } from '@polkadot/util';
 import { drr, refCountDelay } from './util/index.js';
@@ -52,9 +53,8 @@ export class RpcCore {
     __internal__instanceId;
     __internal__isPedantic;
     __internal__registryDefault;
-    __internal__storageCache = new Map();
+    __internal__storageCache;
     __internal__storageCacheHits = 0;
-    __internal__storageCacheSize = 0;
     __internal__getBlockRegistry;
     __internal__getBlockHash;
     mapping = new Map();
@@ -76,6 +76,7 @@ export class RpcCore {
         const sectionNames = Object.keys(rpcDefinitions);
         // these are the base keys (i.e. part of jsonrpc)
         this.sections.push(...sectionNames);
+        this.__internal__storageCache = new LRUCache(DEFAULT_CAPACITY);
         // decorate all interfaces, defined and user on this instance
         this.addUserInterfaces(userRpc);
     }
@@ -94,7 +95,8 @@ export class RpcCore {
     /**
      * @description Manually disconnect from the attached provider
      */
-    disconnect() {
+    async disconnect() {
+        await this.__internal__storageCache.clearInterval();
         return this.provider.disconnect();
     }
     /**
@@ -107,7 +109,7 @@ export class RpcCore {
                 ...stats,
                 core: {
                     cacheHits: this.__internal__storageCacheHits,
-                    cacheSize: this.__internal__storageCacheSize
+                    cacheSize: this.__internal__storageCache.length
                 }
             }
             : undefined;
@@ -371,13 +373,12 @@ export class RpcCore {
             ? value
             : u8aToU8a(value);
         const codec = this._newType(registry, blockHash, key, input, isEmpty, entryIndex);
-        // store the retrieved result - the only issue with this cache is that there is no
-        // 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++;
+        this._setToCache(hexKey, codec);
         return codec;
     }
+    _setToCache(key, value) {
+        this.__internal__storageCache.set(key, value);
+    }
     _newType(registry, blockHash, key, input, isEmpty, entryIndex = -1) {
         // single return value (via state.getStorage), decode the value based on the
         // outputType that we have specified. Fallback to Raw on nothing

package/cjs/bundle.d.ts

@@ -0,0 +1,84 @@
+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 {
+    isPedantic?: boolean;
+    provider: ProviderInterface;
+    userRpc?: Record<string, Record<string, DefinitionRpc | DefinitionRpcSub>>;
+}
+/**
+ * @name Rpc
+ * @summary The API may use a HTTP or WebSockets provider.
+ * @description It allows for querying a Polkadot Client Node.
+ * WebSockets provider is recommended since HTTP provider only supports basic querying.
+ *
+ * ```mermaid
+ * graph LR;
+ *   A[Api] --> |WebSockets| B[WsProvider];
+ *   B --> |endpoint| C[ws://127.0.0.1:9944]
+ * ```
+ *
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import Rpc from '@polkadot/rpc-core';
+ * import { WsProvider } from '@polkadot/rpc-provider/ws';
+ *
+ * const provider = new WsProvider('ws://127.0.0.1:9944');
+ * const rpc = new Rpc(provider);
+ * ```
+ */
+export declare class RpcCore {
+    #private;
+    readonly mapping: Map<string, DefinitionRpcExt>;
+    readonly provider: ProviderInterface;
+    readonly sections: string[];
+    /**
+     * @constructor
+     * Default constructor for the core RPC handler
+     * @param  {ProviderInterface} provider An API provider using any of the supported providers (HTTP, SC or WebSocket)
+     */
+    constructor(instanceId: string, registry: Registry, { isPedantic, provider, userRpc }: Options);
+    /**
+     * @description Returns the connected status of a provider
+     */
+    get isConnected(): boolean;
+    /**
+     * @description Manually connect from the attached provider
+     */
+    connect(): Promise<void>;
+    /**
+     * @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)
+     */
+    setRegistrySwap(registrySwap: (blockHash: Uint8Array) => Promise<{
+        registry: Registry;
+    }>): void;
+    /**
+     * @description Sets a function to resolve block hash from block number
+     */
+    setResolveBlockHash(resolveBlockHash: (blockNumber: AnyNumber) => Promise<Uint8Array>): void;
+    addUserInterfaces(userRpc: Record<string, Record<string, DefinitionRpc | DefinitionRpcSub>>): void;
+    private _memomize;
+    private _formatResult;
+    private _createMethodSend;
+    private _createSubscriber;
+    private _createMethodSubscribe;
+    private _formatParams;
+    private _formatOutput;
+    private _formatStorageData;
+    private _formatStorageSet;
+    private _formatStorageSetEntry;
+    private _setToCache;
+    private _newType;
+}

package/cjs/bundle.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RpcCore = exports.packageInfo = void 0;
 const tslib_1 = require("tslib");
 const rxjs_1 = require("rxjs");
+const rpc_provider_1 = require("@polkadot/rpc-provider");
 const types_1 = require("@polkadot/types");
 const util_1 = require("@polkadot/util");
 const index_js_1 = require("./util/index.js");
@@ -57,9 +58,8 @@ class RpcCore {
     __internal__instanceId;
     __internal__isPedantic;
     __internal__registryDefault;
-    __internal__storageCache = new Map();
+    __internal__storageCache;
     __internal__storageCacheHits = 0;
-    __internal__storageCacheSize = 0;
     __internal__getBlockRegistry;
     __internal__getBlockHash;
     mapping = new Map();
@@ -81,6 +81,7 @@ class RpcCore {
         const sectionNames = Object.keys(types_1.rpcDefinitions);
         // these are the base keys (i.e. part of jsonrpc)
         this.sections.push(...sectionNames);
+        this.__internal__storageCache = new rpc_provider_1.LRUCache(rpc_provider_1.DEFAULT_CAPACITY);
         // decorate all interfaces, defined and user on this instance
         this.addUserInterfaces(userRpc);
     }
@@ -99,7 +100,8 @@ class RpcCore {
     /**
      * @description Manually disconnect from the attached provider
      */
-    disconnect() {
+    async disconnect() {
+        await this.__internal__storageCache.clearInterval();
         return this.provider.disconnect();
     }
     /**
@@ -112,7 +114,7 @@ class RpcCore {
                 ...stats,
                 core: {
                     cacheHits: this.__internal__storageCacheHits,
-                    cacheSize: this.__internal__storageCacheSize
+                    cacheSize: this.__internal__storageCache.length
                 }
             }
             : undefined;
@@ -376,13 +378,12 @@ class RpcCore {
             ? value
             : (0, util_1.u8aToU8a)(value);
         const codec = this._newType(registry, blockHash, key, input, isEmpty, entryIndex);
-        // store the retrieved result - the only issue with this cache is that there is no
-        // 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++;
+        this._setToCache(hexKey, codec);
         return codec;
     }
+    _setToCache(key, value) {
+        this.__internal__storageCache.set(key, value);
+    }
     _newType(registry, blockHash, key, input, isEmpty, entryIndex = -1) {
         // single return value (via state.getStorage), decode the value based on the
         // outputType that we have specified. Fallback to Raw on nothing

package/cjs/index.d.ts

@@ -0,0 +1,2 @@
+import './packageDetect.js';
+export * from './bundle.js';

package/cjs/packageDetect.d.ts

@@ -0,0 +1 @@
+export {};

package/cjs/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

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: '14.0.1' };
+exports.packageInfo = { name: '@polkadot/rpc-core', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '14.2.1' };

package/cjs/types/base.d.ts

@@ -0,0 +1,22 @@
+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>;
+    raw(...params: unknown[]): Observable<unknown>;
+    meta: DefinitionRpc;
+}
+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;
+    };
+}

package/cjs/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@polkadot/rpc-core/types/jsonrpc';
+export * from './base.js';

package/cjs/types/jsonrpc.d.ts

@@ -0,0 +1,2 @@
+export interface RpcInterface {
+}

package/cjs/util/drr.d.ts

@@ -0,0 +1,15 @@
+import type { Observable } from 'rxjs';
+export type DrrResult = <T>(source$: Observable<T>) => Observable<T>;
+interface Options {
+    delay?: number;
+    skipChange?: boolean;
+    skipTimeout?: boolean;
+}
+/**
+ * Shorthand for distinctUntilChanged(), publishReplay(1) and refCount().
+ *
+ * @ignore
+ * @internal
+ */
+export declare function drr({ delay, skipChange, skipTimeout }?: Options): DrrResult;
+export {};

package/cjs/util/index.d.ts

@@ -0,0 +1,3 @@
+export * from './drr.js';
+export * from './memo.js';
+export * from './refCountDelay.js';

package/cjs/util/memo.d.ts

@@ -0,0 +1,6 @@
+import type { Memoized } from '@polkadot/util/types';
+import { Observable } from 'rxjs';
+type ObsFn<T> = (...params: unknown[]) => Observable<T>;
+/** @internal */
+export declare function memo<T>(instanceId: string, inner: Function): Memoized<ObsFn<T>>;
+export {};

package/cjs/util/refCountDelay.d.ts

@@ -0,0 +1,3 @@
+import type { MonoTypeOperatorFunction } from 'rxjs';
+/** @internal */
+export declare function refCountDelay<T>(delay?: number): MonoTypeOperatorFunction<T>;

package/package.json

@@ -18,7 +18,7 @@
     "./cjs/packageDetect.js"
   ],
   "type": "module",
-  "version": "14.0.1",
+  "version": "14.2.1",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -26,88 +26,184 @@
     "./cjs/package.json": "./cjs/package.json",
     "./cjs/*": "./cjs/*.js",
     ".": {
-      "types": "./index.d.ts",
-      "module": "./index.js",
-      "require": "./cjs/index.js",
-      "default": "./index.js"
+      "module": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "types": "./cjs/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "default": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      }
     },
     "./bundle": {
-      "types": "./bundle.d.ts",
-      "module": "./bundle.js",
-      "require": "./cjs/bundle.js",
-      "default": "./bundle.js"
+      "module": {
+        "types": "./bundle.d.ts",
+        "default": "./bundle.js"
+      },
+      "require": {
+        "types": "./cjs/bundle.d.ts",
+        "default": "./cjs/bundle.js"
+      },
+      "default": {
+        "types": "./bundle.d.ts",
+        "default": "./bundle.js"
+      }
     },
     "./package.json": {
       "require": "./cjs/package.json",
       "default": "./package.json"
     },
     "./packageDetect": {
-      "types": "./packageDetect.d.ts",
-      "module": "./packageDetect.js",
-      "require": "./cjs/packageDetect.js",
-      "default": "./packageDetect.js"
+      "module": {
+        "types": "./packageDetect.d.ts",
+        "default": "./packageDetect.js"
+      },
+      "require": {
+        "types": "./cjs/packageDetect.d.ts",
+        "default": "./cjs/packageDetect.js"
+      },
+      "default": {
+        "types": "./packageDetect.d.ts",
+        "default": "./packageDetect.js"
+      }
     },
     "./packageInfo.js": {
-      "types": "./packageInfo.d.ts",
-      "module": "./packageInfo.js",
-      "require": "./cjs/packageInfo.js",
-      "default": "./packageInfo.js"
+      "module": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      },
+      "require": {
+        "types": "./cjs/packageInfo.d.ts",
+        "default": "./cjs/packageInfo.js"
+      },
+      "default": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      }
     },
     "./packageInfo": {
-      "types": "./packageInfo.d.ts",
-      "module": "./packageInfo.js",
-      "require": "./cjs/packageInfo.js",
-      "default": "./packageInfo.js"
+      "module": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      },
+      "require": {
+        "types": "./cjs/packageInfo.d.ts",
+        "default": "./cjs/packageInfo.js"
+      },
+      "default": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      }
     },
     "./types": {
-      "types": "./types/index.d.ts",
-      "module": "./types/index.js",
-      "require": "./cjs/types/index.js",
-      "default": "./types/index.js"
+      "module": {
+        "types": "./types/index.d.ts",
+        "default": "./types/index.js"
+      },
+      "require": {
+        "types": "./cjs/types/index.d.ts",
+        "default": "./cjs/types/index.js"
+      },
+      "default": {
+        "types": "./types/index.d.ts",
+        "default": "./types/index.js"
+      }
     },
     "./types/base": {
-      "types": "./types/base.d.ts",
-      "module": "./types/base.js",
-      "require": "./cjs/types/base.js",
-      "default": "./types/base.js"
+      "module": {
+        "types": "./types/base.d.ts",
+        "default": "./types/base.js"
+      },
+      "require": {
+        "types": "./cjs/types/base.d.ts",
+        "default": "./cjs/types/base.js"
+      },
+      "default": {
+        "types": "./types/base.d.ts",
+        "default": "./types/base.js"
+      }
     },
     "./types/jsonrpc": {
-      "types": "./types/jsonrpc.d.ts",
-      "module": "./types/jsonrpc.js",
-      "require": "./cjs/types/jsonrpc.js",
-      "default": "./types/jsonrpc.js"
+      "module": {
+        "types": "./types/jsonrpc.d.ts",
+        "default": "./types/jsonrpc.js"
+      },
+      "require": {
+        "types": "./cjs/types/jsonrpc.d.ts",
+        "default": "./cjs/types/jsonrpc.js"
+      },
+      "default": {
+        "types": "./types/jsonrpc.d.ts",
+        "default": "./types/jsonrpc.js"
+      }
     },
     "./util": {
-      "types": "./util/index.d.ts",
-      "module": "./util/index.js",
-      "require": "./cjs/util/index.js",
-      "default": "./util/index.js"
+      "module": {
+        "types": "./util/index.d.ts",
+        "default": "./util/index.js"
+      },
+      "require": {
+        "types": "./cjs/util/index.d.ts",
+        "default": "./cjs/util/index.js"
+      },
+      "default": {
+        "types": "./util/index.d.ts",
+        "default": "./util/index.js"
+      }
     },
     "./util/drr": {
-      "types": "./util/drr.d.ts",
-      "module": "./util/drr.js",
-      "require": "./cjs/util/drr.js",
-      "default": "./util/drr.js"
+      "module": {
+        "types": "./util/drr.d.ts",
+        "default": "./util/drr.js"
+      },
+      "require": {
+        "types": "./cjs/util/drr.d.ts",
+        "default": "./cjs/util/drr.js"
+      },
+      "default": {
+        "types": "./util/drr.d.ts",
+        "default": "./util/drr.js"
+      }
     },
     "./util/memo": {
-      "types": "./util/memo.d.ts",
-      "module": "./util/memo.js",
-      "require": "./cjs/util/memo.js",
-      "default": "./util/memo.js"
+      "module": {
+        "types": "./util/memo.d.ts",
+        "default": "./util/memo.js"
+      },
+      "require": {
+        "types": "./cjs/util/memo.d.ts",
+        "default": "./cjs/util/memo.js"
+      },
+      "default": {
+        "types": "./util/memo.d.ts",
+        "default": "./util/memo.js"
+      }
     },
     "./util/refCountDelay": {
-      "types": "./util/refCountDelay.d.ts",
-      "module": "./util/refCountDelay.js",
-      "require": "./cjs/util/refCountDelay.js",
-      "default": "./util/refCountDelay.js"
+      "module": {
+        "types": "./util/refCountDelay.d.ts",
+        "default": "./util/refCountDelay.js"
+      },
+      "require": {
+        "types": "./cjs/util/refCountDelay.d.ts",
+        "default": "./cjs/util/refCountDelay.js"
+      },
+      "default": {
+        "types": "./util/refCountDelay.d.ts",
+        "default": "./util/refCountDelay.js"
+      }
     }
   },
   "dependencies": {
-    "@polkadot/rpc-augment": "14.0.1",
-    "@polkadot/rpc-provider": "14.0.1",
-    "@polkadot/types": "14.0.1",
-    "@polkadot/util": "^13.1.1",
+    "@polkadot/rpc-augment": "14.2.1",
+    "@polkadot/rpc-provider": "14.2.1",
+    "@polkadot/types": "14.2.1",
+    "@polkadot/util": "^13.2.2",
     "rxjs": "^7.8.1",
-    "tslib": "^2.7.0"
+    "tslib": "^2.8.0"
   }
 }

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: '14.0.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: '14.2.1' };