@pezkuwi/rpc-provider 16.5.5

package/src/http/index.ts

@@ -0,0 +1,238 @@
+// Copyright 2017-2025 @polkadot/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type RpcError from '../coder/error.js';
+import type { JsonRpcResponse, ProviderInterface, ProviderInterfaceCallback, ProviderInterfaceEmitCb, ProviderInterfaceEmitted, ProviderStats } from '../types.js';
+
+import { logger, noop, stringify } from '@pezkuwi/util';
+import { fetch } from '@pezkuwi/x-fetch';
+
+import { RpcCoder } from '../coder/index.js';
+import defaults from '../defaults.js';
+import { DEFAULT_CAPACITY, DEFAULT_TTL, LRUCache } from '../lru.js';
+
+const ERROR_SUBSCRIBE = 'HTTP Provider does not have subscriptions, use WebSockets instead';
+
+const l = logger('api-http');
+
+/**
+ * # @polkadot/rpc-provider
+ *
+ * @name HttpProvider
+ *
+ * @description The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port. It does not support subscriptions so you won't be able to listen to events such as new blocks or balance changes. It is usually preferable using the [[WsProvider]].
+ *
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import Api from '@pezkuwi/api/promise';
+ * import { HttpProvider } from '@pezkuwi/rpc-provider';
+ *
+ * const provider = new HttpProvider('http://127.0.0.1:9933');
+ * const api = new Api(provider);
+ * ```
+ *
+ * @see [[WsProvider]]
+ */
+export class HttpProvider implements ProviderInterface {
+  readonly #callCache: LRUCache;
+  readonly #cacheCapacity: number;
+  readonly #coder: RpcCoder;
+  readonly #endpoint: string;
+  readonly #headers: Record<string, string>;
+  readonly #stats: ProviderStats;
+  readonly #ttl: number | null | undefined;
+
+  /**
+   * @param {string} endpoint The endpoint url starting with http://
+   * @param {Record<string, string>} headers The headers provided to the underlying Http Endpoint
+   * @param {number} [cacheCapacity] Custom size of the HttpProvider LRUCache. Defaults to `DEFAULT_CAPACITY` (1024)
+   * @param {number} [cacheTtl] Custom TTL of the HttpProvider LRUCache. Determines how long an object can live in the cache. Defaults to `DEFAULT_TTL` (30000)
+   */
+  constructor (endpoint: string = defaults.HTTP_URL, headers: Record<string, string> = {}, cacheCapacity?: number, cacheTtl?: number | null) {
+    if (!/^(https|http):\/\//.test(endpoint)) {
+      throw new Error(`Endpoint should start with 'http://' or 'https://', received '${endpoint}'`);
+    }
+
+    this.#coder = new RpcCoder();
+    this.#endpoint = endpoint;
+    this.#headers = headers;
+    this.#cacheCapacity = cacheCapacity === 0 ? 0 : cacheCapacity || DEFAULT_CAPACITY;
+
+    const ttl = cacheTtl === undefined ? DEFAULT_TTL : cacheTtl;
+
+    this.#callCache = new LRUCache(cacheCapacity === 0 ? 0 : cacheCapacity || DEFAULT_CAPACITY, ttl);
+    this.#ttl = cacheTtl;
+
+    this.#stats = {
+      active: { requests: 0, subscriptions: 0 },
+      total: { bytesRecv: 0, bytesSent: 0, cached: 0, errors: 0, requests: 0, subscriptions: 0, timeout: 0 }
+    };
+  }
+
+  /**
+   * @summary `true` when this provider supports subscriptions
+   */
+  public get hasSubscriptions (): boolean {
+    return !!false;
+  }
+
+  /**
+   * @description Returns a clone of the object
+   */
+  public clone (): HttpProvider {
+    return new HttpProvider(this.#endpoint, this.#headers);
+  }
+
+  /**
+   * @description Manually connect from the connection
+   */
+  public async connect (): Promise<void> {
+    // noop
+  }
+
+  /**
+   * @description Manually disconnect from the connection
+   */
+  public async disconnect (): Promise<void> {
+    // noop
+  }
+
+  /**
+   * @description Returns the connection stats
+   */
+  public get stats (): ProviderStats {
+    return this.#stats;
+  }
+
+  /**
+  * @description Returns the connection stats
+  */
+  public get ttl (): number | null | undefined {
+    return this.#ttl;
+  }
+
+  /**
+   * @summary `true` when this provider supports clone()
+   */
+  public get isClonable (): boolean {
+    return !!true;
+  }
+
+  /**
+   * @summary Whether the node is connected or not.
+   * @return {boolean} true if connected
+   */
+  public get isConnected (): boolean {
+    return !!true;
+  }
+
+  /**
+   * @summary Events are not supported with the HttpProvider, see [[WsProvider]].
+   * @description HTTP Provider does not have 'on' emitters. WebSockets should be used instead.
+   */
+  public on (_type: ProviderInterfaceEmitted, _sub: ProviderInterfaceEmitCb): () => void {
+    l.error('HTTP Provider does not have \'on\' emitters, use WebSockets instead');
+
+    return noop;
+  }
+
+  /**
+   * @summary Send HTTP POST Request with Body to configured HTTP Endpoint.
+   */
+  public async send <T> (method: string, params: unknown[], isCacheable?: boolean): Promise<T> {
+    this.#stats.total.requests++;
+
+    const [, body] = this.#coder.encodeJson(method, params);
+
+    if (this.#cacheCapacity === 0) {
+      return this.#send(body);
+    }
+
+    const cacheKey = isCacheable ? `${method}::${stringify(params)}` : '';
+    let resultPromise: Promise<T> | null = isCacheable
+      ? this.#callCache.get(cacheKey)
+      : null;
+
+    if (!resultPromise) {
+      resultPromise = this.#send(body);
+
+      if (isCacheable) {
+        this.#callCache.set(cacheKey, resultPromise);
+      }
+    } else {
+      this.#stats.total.cached++;
+    }
+
+    return resultPromise;
+  }
+
+  async #send <T> (body: string): Promise<T> {
+    this.#stats.active.requests++;
+    this.#stats.total.bytesSent += body.length;
+
+    try {
+      const response = await fetch(this.#endpoint, {
+        body,
+        headers: {
+          Accept: 'application/json',
+          'Content-Length': `${body.length}`,
+          'Content-Type': 'application/json',
+          ...this.#headers
+        },
+        method: 'POST'
+      });
+
+      if (!response.ok) {
+        throw new Error(`[${response.status}]: ${response.statusText}`);
+      }
+
+      const result = await response.text();
+
+      this.#stats.total.bytesRecv += result.length;
+
+      const decoded = this.#coder.decodeResponse(JSON.parse(result) as JsonRpcResponse<T>);
+
+      this.#stats.active.requests--;
+
+      return decoded;
+    } catch (e) {
+      this.#stats.active.requests--;
+      this.#stats.total.errors++;
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const { method, params } = JSON.parse(body);
+
+      const rpcError: RpcError = e as RpcError;
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const failedRequest = `\nFailed HTTP Request: ${JSON.stringify({ method, params })}`;
+
+      // Provide HTTP Request alongside the error
+      rpcError.message = `${rpcError.message}${failedRequest}`;
+
+      throw rpcError;
+    }
+  }
+
+  /**
+   * @summary Subscriptions are not supported with the HttpProvider, see [[WsProvider]].
+   */
+  // eslint-disable-next-line @typescript-eslint/require-await
+  public async subscribe (_types: string, _method: string, _params: unknown[], _cb: ProviderInterfaceCallback): Promise<number> {
+    l.error(ERROR_SUBSCRIBE);
+
+    throw new Error(ERROR_SUBSCRIBE);
+  }
+
+  /**
+   * @summary Subscriptions are not supported with the HttpProvider, see [[WsProvider]].
+   */
+  // eslint-disable-next-line @typescript-eslint/require-await
+  public async unsubscribe (_type: string, _method: string, _id: number): Promise<boolean> {
+    l.error(ERROR_SUBSCRIBE);
+
+    throw new Error(ERROR_SUBSCRIBE);
+  }
+}

package/src/http/send.spec.ts

@@ -0,0 +1,61 @@
+// Copyright 2017-2025 @polkadot/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { Mock } from '../mock/types.js';
+
+import { mockHttp, TEST_HTTP_URL } from '../mock/mockHttp.js';
+import { HttpProvider } from './index.js';
+
+// Does not work with Node 18 (native fetch)
+// See https://github.com/nock/nock/issues/2397
+// eslint-disable-next-line jest/no-disabled-tests
+describe.skip('send', (): void => {
+  let http: HttpProvider;
+  let mock: Mock;
+
+  beforeEach((): void => {
+    http = new HttpProvider(TEST_HTTP_URL);
+  });
+
+  afterEach(async () => {
+    if (mock) {
+      await mock.done();
+    }
+  });
+
+  it('passes the body through correctly', (): Promise<void> => {
+    mock = mockHttp([{
+      method: 'test_body',
+      reply: {
+        result: 'ok'
+      }
+    }]);
+
+    return http
+      .send('test_body', ['param'])
+      .then((): void => {
+        expect(mock.body['test_body']).toEqual({
+          id: 1,
+          jsonrpc: '2.0',
+          method: 'test_body',
+          params: ['param']
+        });
+      });
+  });
+
+  it('throws error when !response.ok', async (): Promise<any> => {
+    mock = mockHttp([{
+      code: 500,
+      method: 'test_error'
+    }]);
+
+    return http
+      .send('test_error', [])
+      .catch((error): void => {
+        // eslint-disable-next-line jest/no-conditional-expect
+        expect((error as Error).message).toMatch(/\[500\]/);
+      });
+  });
+});

package/src/http/types.ts

@@ -0,0 +1,11 @@
+// Copyright 2017-2025 @polkadot/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Logger } from '@pezkuwi/util/types';
+import type { RpcCoder } from '../coder/index.js';
+
+export interface HttpState {
+  coder: RpcCoder;
+  endpoint: string;
+  l: Logger;
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+// Copyright 2017-2025 @polkadot/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import './packageDetect.js';
+
+export * from './bundle.js';

package/src/lru.spec.ts

@@ -0,0 +1,74 @@
+// Copyright 2017-2025 @polkadot/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { LRUCache } from './lru.js';
+
+describe('LRUCache', (): void => {
+  let lru: LRUCache | undefined;
+
+  beforeEach((): void => {
+    lru = new LRUCache(4, 500);
+  });
+
+  it('allows getting of items below capacity', (): void => {
+    const keys = ['1', '2', '3', '4'];
+
+    keys.forEach((k) => lru?.set(k, `${k}${k}${k}`));
+    const lruKeys = lru?.keys();
+
+    expect(lruKeys?.join(', ')).toBe(keys.reverse().join(', '));
+    expect(lru?.length === lru?.lengthData && lru?.length === lru?.lengthRefs).toBe(true);
+
+    keys.forEach((k) => expect(lru?.get(k)).toEqual(`${k}${k}${k}`));
+  });
+
+  it('drops items when at capacity', (): void => {
+    const keys = ['1', '2', '3', '4', '5', '6'];
+
+    keys.forEach((k) => lru?.set(k, `${k}${k}${k}`));
+
+    expect(lru?.keys().join(', ')).toEqual(keys.slice(2).reverse().join(', '));
+    expect(lru?.length === lru?.lengthData && lru?.length === lru?.lengthRefs).toBe(true);
+
+    keys.slice(2).forEach((k) => expect(lru?.get(k)).toEqual(`${k}${k}${k}`));
+  });
+
+  it('adjusts the order as they are used', (): void => {
+    const keys = ['1', '2', '3', '4', '5'];
+
+    keys.forEach((k) => lru?.set(k, `${k}${k}${k}`));
+
+    expect(lru?.entries()).toEqual([['5', '555'], ['4', '444'], ['3', '333'], ['2', '222']]);
+    expect(lru?.length === lru?.lengthData && lru?.length === lru?.lengthRefs).toBe(true);
+
+    lru?.get('3');
+
+    expect(lru?.entries()).toEqual([['3', '333'], ['5', '555'], ['4', '444'], ['2', '222']]);
+    expect(lru?.length === lru?.lengthData && lru?.length === lru?.lengthRefs).toBe(true);
+
+    lru?.set('4', '4433');
+
+    expect(lru?.entries()).toEqual([['4', '4433'], ['3', '333'], ['5', '555'], ['2', '222']]);
+    expect(lru?.length === lru?.lengthData && lru?.length === lru?.lengthRefs).toBe(true);
+
+    lru?.set('6', '666');
+
+    expect(lru?.entries()).toEqual([['6', '666'], ['4', '4433'], ['3', '333'], ['5', '555']]);
+    expect(lru?.length === lru?.lengthData && lru?.length === lru?.lengthRefs).toBe(true);
+  });
+
+  it('evicts items with TTL', (): void => {
+    const keys = ['1', '2', '3', '4', '5'];
+
+    keys.forEach((k) => lru?.set(k, `${k}${k}${k}`));
+
+    expect(lru?.entries()).toEqual([['5', '555'], ['4', '444'], ['3', '333'], ['2', '222']]);
+
+    setTimeout((): void => {
+      lru?.get('3');
+      expect(lru?.entries()).toEqual([['3', '333']]);
+    }, 800);
+  });
+});

package/src/lru.ts

@@ -0,0 +1,197 @@
+// Copyright 2017-2025 @polkadot/rpc-provider authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Assuming all 1.5MB responses, we apply a default allowing for 192MB
+// cache space (depending on the historic queries this would vary, metadata
+// for Kusama/Polkadot/Substrate falls between 600-750K, 2x for estimate)
+
+export const DEFAULT_CAPACITY = 1024;
+export const DEFAULT_TTL = 30000; // 30 seconds
+const MAX_TTL = 1800_000; // 30 minutes
+
+// If the user decides to disable the TTL we set the value
+// to a very high number (A year = 365 * 24 * 60 * 60 * 1000).
+const DISABLED_TTL = 31_536_000_000;
+
+class LRUNode {
+  readonly key: string;
+  #expires: number;
+  #ttl: number;
+  readonly createdAt: number;
+
+  public next: LRUNode;
+  public prev: LRUNode;
+
+  constructor (key: string, ttl: number) {
+    this.key = key;
+    this.#ttl = ttl;
+    this.#expires = Date.now() + ttl;
+    this.createdAt = Date.now();
+    this.next = this.prev = this;
+  }
+
+  public refresh (): void {
+    this.#expires = Date.now() + this.#ttl;
+  }
+
+  public get expiry (): number {
+    return this.#expires;
+  }
+}
+
+// https://en.wikipedia.org/wiki/Cache_replacement_policies#LRU
+export class LRUCache {
+  readonly capacity: number;
+
+  readonly #data = new Map<string, unknown>();
+  readonly #refs = new Map<string, LRUNode>();
+
+  #length = 0;
+  #head: LRUNode;
+  #tail: LRUNode;
+
+  readonly #ttl: number;
+
+  constructor (capacity = DEFAULT_CAPACITY, ttl: number | null = DEFAULT_TTL) {
+    // Validate capacity
+    if (!Number.isInteger(capacity) || capacity < 0) {
+      throw new Error(`LRUCache initialization error: 'capacity' must be a non-negative integer. Received: ${capacity}`);
+    }
+
+    // Validate ttl
+    if (ttl !== null && (!Number.isFinite(ttl) || ttl < 0 || ttl > MAX_TTL)) {
+      throw new Error(`LRUCache initialization error: 'ttl' must be between 0 and ${MAX_TTL} ms or null to disable. Received: ${ttl}`);
+    }
+
+    this.capacity = capacity;
+    ttl ? this.#ttl = ttl : this.#ttl = DISABLED_TTL;
+    this.#head = this.#tail = new LRUNode('<empty>', this.#ttl);
+  }
+
+  get ttl (): number | null {
+    return this.#ttl;
+  }
+
+  get length (): number {
+    return this.#length;
+  }
+
+  get lengthData (): number {
+    return this.#data.size;
+  }
+
+  get lengthRefs (): number {
+    return this.#refs.size;
+  }
+
+  entries (): [string, unknown][] {
+    const keys = this.keys();
+    const count = keys.length;
+    const entries = new Array<[string, unknown]>(count);
+
+    for (let i = 0; i < count; i++) {
+      const key = keys[i];
+
+      entries[i] = [key, this.#data.get(key)];
+    }
+
+    return entries;
+  }
+
+  keys (): string[] {
+    const keys: string[] = [];
+
+    if (this.#length) {
+      let curr = this.#head;
+
+      while (curr !== this.#tail) {
+        keys.push(curr.key);
+        curr = curr.next;
+      }
+
+      keys.push(curr.key);
+    }
+
+    return keys;
+  }
+
+  get <T> (key: string): T | null {
+    const data = this.#data.get(key);
+
+    if (data) {
+      this.#toHead(key);
+
+      // Evict TTL once data is refreshed
+      this.#evictTTL();
+
+      return data as T;
+    }
+
+    this.#evictTTL();
+
+    return null;
+  }
+
+  set <T> (key: string, value: T): void {
+    if (this.#data.has(key)) {
+      this.#toHead(key);
+    } else {
+      const node = new LRUNode(key, this.#ttl);
+
+      this.#refs.set(node.key, node);
+
+      if (this.length === 0) {
+        this.#head = this.#tail = node;
+      } else {
+        this.#head.prev = node;
+        node.next = this.#head;
+        this.#head = node;
+      }
+
+      if (this.#length === this.capacity) {
+        this.#data.delete(this.#tail.key);
+        this.#refs.delete(this.#tail.key);
+
+        this.#tail = this.#tail.prev;
+        this.#tail.next = this.#head;
+      } else {
+        this.#length += 1;
+      }
+    }
+
+    // Evict TTL once data is refreshed or added
+    this.#evictTTL();
+
+    this.#data.set(key, value);
+  }
+
+  #evictTTL () {
+  // Find last node to keep
+    // traverse map to find the expired nodes
+    while (this.#tail.expiry && this.#tail.expiry < Date.now() && this.#length > 0) {
+      this.#refs.delete(this.#tail.key);
+      this.#data.delete(this.#tail.key);
+      this.#length -= 1;
+      this.#tail = this.#tail.prev;
+      this.#tail.next = this.#head;
+    }
+
+    if (this.#length === 0) {
+      this.#head = this.#tail = new LRUNode('<empty>', this.#ttl);
+    }
+  }
+
+  #toHead (key: string): void {
+    const ref = this.#refs.get(key);
+
+    if (ref && ref !== this.#head) {
+      ref.refresh();
+      ref.prev.next = ref.next;
+      ref.next.prev = ref.prev;
+      ref.next = this.#head;
+
+      this.#head.prev = ref;
+      this.#head = ref;
+    }
+  }
+}