@pezkuwi/rpc-provider 16.5.8 → 16.5.9

package/build-tsc-esm/coder/index.js

@@ -1,58 +0,0 @@
-import { isNumber, isString, isUndefined, stringify } from '@pezkuwi/util';
-import RpcError from './error.js';
-function formatErrorData(data) {
-    if (isUndefined(data)) {
-        return '';
-    }
-    const formatted = `: ${isString(data)
-        ? data.replace(/Error\("/g, '').replace(/\("/g, '(').replace(/"\)/g, ')').replace(/\(/g, ', ').replace(/\)/g, '')
-        : stringify(data)}`;
-    // We need some sort of cut-off here since these can be very large and
-    // very nested, pick a number and trim the result display to it
-    return formatted.length <= 256
-        ? formatted
-        : `${formatted.substring(0, 255)}…`;
-}
-function checkError(error) {
-    if (error) {
-        const { code, data, message } = error;
-        throw new RpcError(`${code}: ${message}${formatErrorData(data)}`, code, data);
-    }
-}
-/** @internal */
-export class RpcCoder {
-    #id = 0;
-    decodeResponse(response) {
-        if (!response || response.jsonrpc !== '2.0') {
-            throw new Error('Invalid jsonrpc field in decoded object');
-        }
-        const isSubscription = !isUndefined(response.params) && !isUndefined(response.method);
-        if (!isNumber(response.id) &&
-            (!isSubscription || (!isNumber(response.params.subscription) &&
-                !isString(response.params.subscription)))) {
-            throw new Error('Invalid id field in decoded object');
-        }
-        checkError(response.error);
-        if (response.result === undefined && !isSubscription) {
-            throw new Error('No result found in jsonrpc response');
-        }
-        if (isSubscription) {
-            checkError(response.params.error);
-            return response.params.result;
-        }
-        return response.result;
-    }
-    encodeJson(method, params) {
-        const [id, data] = this.encodeObject(method, params);
-        return [id, stringify(data)];
-    }
-    encodeObject(method, params) {
-        const id = ++this.#id;
-        return [id, {
-                id,
-                jsonrpc: '2.0',
-                method,
-                params
-            }];
-    }
-}

package/build-tsc-esm/defaults.js

@@ -1,6 +0,0 @@
-const HTTP_URL = 'http://127.0.0.1:9933';
-const WS_URL = 'ws://127.0.0.1:9944';
-export default {
-    HTTP_URL,
-    WS_URL
-};

package/build-tsc-esm/http/index.js

@@ -1,191 +0,0 @@
-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');
-/**
- * # @pezkuwi/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 {
-    #callCache;
-    #cacheCapacity;
-    #coder;
-    #endpoint;
-    #headers;
-    #stats;
-    #ttl;
-    /**
-     * @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 = defaults.HTTP_URL, headers = {}, cacheCapacity, cacheTtl) {
-        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
-     */
-    get hasSubscriptions() {
-        return !!false;
-    }
-    /**
-     * @description Returns a clone of the object
-     */
-    clone() {
-        return new HttpProvider(this.#endpoint, this.#headers);
-    }
-    /**
-     * @description Manually connect from the connection
-     */
-    async connect() {
-        // noop
-    }
-    /**
-     * @description Manually disconnect from the connection
-     */
-    async disconnect() {
-        // noop
-    }
-    /**
-     * @description Returns the connection stats
-     */
-    get stats() {
-        return this.#stats;
-    }
-    /**
-    * @description Returns the connection stats
-    */
-    get ttl() {
-        return this.#ttl;
-    }
-    /**
-     * @summary `true` when this provider supports clone()
-     */
-    get isClonable() {
-        return !!true;
-    }
-    /**
-     * @summary Whether the node is connected or not.
-     * @return {boolean} true if connected
-     */
-    get isConnected() {
-        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.
-     */
-    on(_type, _sub) {
-        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.
-     */
-    async send(method, params, isCacheable) {
-        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 = 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(body) {
-        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));
-            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 = e;
-            // 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
-    async subscribe(_types, _method, _params, _cb) {
-        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
-    async unsubscribe(_type, _method, _id) {
-        l.error(ERROR_SUBSCRIBE);
-        throw new Error(ERROR_SUBSCRIBE);
-    }
-}

package/build-tsc-esm/http/types.js

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

package/build-tsc-esm/index.js

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

package/build-tsc-esm/lru.js

@@ -1,146 +0,0 @@
-export const DEFAULT_CAPACITY = 1024;
-export const DEFAULT_TTL = 30000; // 30 seconds
-const MAX_TTL = 1800_000; // 30 minutes
-const DISABLED_TTL = 31_536_000_000;
-class LRUNode {
-    key;
-    #expires;
-    #ttl;
-    createdAt;
-    next;
-    prev;
-    constructor(key, ttl) {
-        this.key = key;
-        this.#ttl = ttl;
-        this.#expires = Date.now() + ttl;
-        this.createdAt = Date.now();
-        this.next = this.prev = this;
-    }
-    refresh() {
-        this.#expires = Date.now() + this.#ttl;
-    }
-    get expiry() {
-        return this.#expires;
-    }
-}
-export class LRUCache {
-    capacity;
-    #data = new Map();
-    #refs = new Map();
-    #length = 0;
-    #head;
-    #tail;
-    #ttl;
-    constructor(capacity = DEFAULT_CAPACITY, ttl = 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() {
-        return this.#ttl;
-    }
-    get length() {
-        return this.#length;
-    }
-    get lengthData() {
-        return this.#data.size;
-    }
-    get lengthRefs() {
-        return this.#refs.size;
-    }
-    entries() {
-        const keys = this.keys();
-        const count = keys.length;
-        const entries = new Array(count);
-        for (let i = 0; i < count; i++) {
-            const key = keys[i];
-            entries[i] = [key, this.#data.get(key)];
-        }
-        return entries;
-    }
-    keys() {
-        const keys = [];
-        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(key) {
-        const data = this.#data.get(key);
-        if (data) {
-            this.#toHead(key);
-            // Evict TTL once data is refreshed
-            this.#evictTTL();
-            return data;
-        }
-        this.#evictTTL();
-        return null;
-    }
-    set(key, value) {
-        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) {
-        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;
-        }
-    }
-}

package/build-tsc-esm/mock/index.js

@@ -1,191 +0,0 @@
-import { EventEmitter } from 'eventemitter3';
-import { createTestKeyring } from '@pezkuwi/keyring/testing';
-import { decorateStorage, Metadata } from '@pezkuwi/types';
-import jsonrpc from '@pezkuwi/types/interfaces/jsonrpc';
-import rpcHeader from '@pezkuwi/types-support/json/Header.004.json' assert { type: 'json' };
-import rpcSignedBlock from '@pezkuwi/types-support/json/SignedBlock.004.immortal.json' assert { type: 'json' };
-import rpcMetadata from '@pezkuwi/types-support/metadata/static-bizinikiwi';
-import { BN, bnToU8a, logger, u8aToHex } from '@pezkuwi/util';
-import { randomAsU8a } from '@pezkuwi/util-crypto';
-const INTERVAL = 1000;
-const SUBSCRIPTIONS = Array.prototype.concat.apply([], Object.values(jsonrpc).map((section) => Object
-    .values(section)
-    .filter(({ isSubscription }) => isSubscription)
-    .map(({ jsonrpc }) => jsonrpc)
-    .concat('chain_subscribeNewHead')));
-const keyring = createTestKeyring({ type: 'ed25519' });
-const l = logger('api-mock');
-/**
- * A mock provider mainly used for testing.
- * @return {ProviderInterface} The mock provider
- * @internal
- */
-export class MockProvider {
-    db = {};
-    emitter = new EventEmitter();
-    intervalId;
-    isUpdating = true;
-    registry;
-    prevNumber = new BN(-1);
-    requests = {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        chain_getBlock: () => this.registry.createType('SignedBlock', rpcSignedBlock.result).toJSON(),
-        chain_getBlockHash: () => '0x1234000000000000000000000000000000000000000000000000000000000000',
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        chain_getFinalizedHead: () => this.registry.createType('Header', rpcHeader.result).hash,
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        chain_getHeader: () => this.registry.createType('Header', rpcHeader.result).toJSON(),
-        rpc_methods: () => this.registry.createType('RpcMethods').toJSON(),
-        state_getKeys: () => [],
-        state_getKeysPaged: () => [],
-        state_getMetadata: () => rpcMetadata,
-        state_getRuntimeVersion: () => this.registry.createType('RuntimeVersion').toHex(),
-        state_getStorage: (storage, [key]) => u8aToHex(storage[key]),
-        system_chain: () => 'mockChain',
-        system_health: () => ({}),
-        system_name: () => 'mockClient',
-        system_properties: () => ({ ss58Format: 42 }),
-        system_upgradedToTripleRefCount: () => this.registry.createType('bool', true),
-        system_version: () => '9.8.7',
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-return, sort-keys
-        dev_echo: (_, params) => params
-    };
-    subscriptions = SUBSCRIPTIONS.reduce((subs, name) => {
-        subs[name] = {
-            callbacks: {},
-            lastValue: null
-        };
-        return subs;
-    }, {});
-    subscriptionId = 0;
-    subscriptionMap = {};
-    constructor(registry) {
-        this.registry = registry;
-        this.init();
-    }
-    get hasSubscriptions() {
-        return !!true;
-    }
-    clone() {
-        throw new Error('Unimplemented');
-    }
-    async connect() {
-        // noop
-    }
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async disconnect() {
-        if (this.intervalId) {
-            clearInterval(this.intervalId);
-            this.intervalId = null;
-        }
-    }
-    get isClonable() {
-        return !!false;
-    }
-    get isConnected() {
-        return !!true;
-    }
-    on(type, sub) {
-        this.emitter.on(type, sub);
-        return () => {
-            this.emitter.removeListener(type, sub);
-        };
-    }
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async send(method, params) {
-        l.debug(() => ['send', method, params]);
-        if (!this.requests[method]) {
-            throw new Error(`provider.send: Invalid method '${method}'`);
-        }
-        return this.requests[method](this.db, params);
-    }
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async subscribe(_type, method, ...params) {
-        l.debug(() => ['subscribe', method, params]);
-        if (!this.subscriptions[method]) {
-            throw new Error(`provider.subscribe: Invalid method '${method}'`);
-        }
-        const callback = params.pop();
-        const id = ++this.subscriptionId;
-        this.subscriptions[method].callbacks[id] = callback;
-        this.subscriptionMap[id] = method;
-        if (this.subscriptions[method].lastValue !== null) {
-            callback(null, this.subscriptions[method].lastValue);
-        }
-        return id;
-    }
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async unsubscribe(_type, _method, id) {
-        const sub = this.subscriptionMap[id];
-        l.debug(() => ['unsubscribe', id, sub]);
-        if (!sub) {
-            throw new Error(`Unable to find subscription for ${id}`);
-        }
-        delete this.subscriptionMap[id];
-        delete this.subscriptions[sub].callbacks[id];
-        return true;
-    }
-    init() {
-        const emitEvents = ['connected', 'disconnected'];
-        let emitIndex = 0;
-        let newHead = this.makeBlockHeader();
-        let counter = -1;
-        const metadata = new Metadata(this.registry, rpcMetadata);
-        this.registry.setMetadata(metadata);
-        const query = decorateStorage(this.registry, metadata.asLatest, metadata.version);
-        // Do something every 1 seconds
-        this.intervalId = setInterval(() => {
-            if (!this.isUpdating) {
-                return;
-            }
-            // create a new header (next block)
-            newHead = this.makeBlockHeader();
-            // increment the balances and nonce for each account
-            keyring.getPairs().forEach(({ publicKey }, index) => {
-                this.setStateBn(query['system']['account'](publicKey), newHead.number.toBn().addn(index));
-            });
-            // set the timestamp for the current block
-            this.setStateBn(query['timestamp']['now'](), Math.floor(Date.now() / 1000));
-            this.updateSubs('chain_subscribeNewHead', newHead);
-            // We emit connected/disconnected at intervals
-            if (++counter % 2 === 1) {
-                if (++emitIndex === emitEvents.length) {
-                    emitIndex = 0;
-                }
-                this.emitter.emit(emitEvents[emitIndex]);
-            }
-        }, INTERVAL);
-    }
-    makeBlockHeader() {
-        const blockNumber = this.prevNumber.addn(1);
-        const header = this.registry.createType('Header', {
-            digest: {
-                logs: []
-            },
-            extrinsicsRoot: randomAsU8a(),
-            number: blockNumber,
-            parentHash: blockNumber.isZero()
-                ? new Uint8Array(32)
-                : bnToU8a(this.prevNumber, { bitLength: 256, isLe: false }),
-            stateRoot: bnToU8a(blockNumber, { bitLength: 256, isLe: false })
-        });
-        this.prevNumber = blockNumber;
-        return header;
-    }
-    setStateBn(key, value) {
-        this.db[u8aToHex(key)] = bnToU8a(value, { bitLength: 64, isLe: true });
-    }
-    updateSubs(method, value) {
-        this.subscriptions[method].lastValue = value;
-        Object
-            .values(this.subscriptions[method].callbacks)
-            .forEach((cb) => {
-            try {
-                cb(null, value.toJSON());
-            }
-            catch (error) {
-                l.error(`Error on '${method}' subscription`, error);
-            }
-        });
-    }
-}

package/build-tsc-esm/mock/mockHttp.js

@@ -1,12 +0,0 @@
-import nock from 'nock';
-export const TEST_HTTP_URL = 'http://localhost:9944';
-export function mockHttp(requests) {
-    nock.cleanAll();
-    return requests.reduce((scope, request) => scope
-        .post('/')
-        .reply(request.code || 200, (_uri, body) => {
-        scope.body = scope.body || {};
-        scope.body[request.method] = body;
-        return Object.assign({ id: body.id, jsonrpc: '2.0' }, request.reply || {});
-    }), nock(TEST_HTTP_URL));
-}

package/build-tsc-esm/mock/mockWs.js

@@ -1,43 +0,0 @@
-import { Server, WebSocket } from 'mock-socket';
-import { stringify } from '@pezkuwi/util';
-global.WebSocket = WebSocket;
-export const TEST_WS_URL = 'ws://localhost:9955';
-function createError({ error: { code, message }, id }) {
-    return {
-        error: {
-            code,
-            message
-        },
-        id,
-        jsonrpc: '2.0'
-    };
-}
-function createReply({ id, reply: { result } }) {
-    return {
-        id,
-        jsonrpc: '2.0',
-        result
-    };
-}
-export function mockWs(requests, wsUrl = TEST_WS_URL) {
-    const server = new Server(wsUrl);
-    let requestCount = 0;
-    const scope = {
-        body: {},
-        done: () => new Promise((resolve) => server.stop(resolve)),
-        requests: 0,
-        server
-    };
-    server.on('connection', (socket) => {
-        socket.on('message', (body) => {
-            const request = requests[requestCount];
-            const response = request.error
-                ? createError(request)
-                : createReply(request);
-            scope.body[request.method] = body;
-            requestCount++;
-            socket.send(stringify(response));
-        });
-    });
-    return scope;
-}

package/build-tsc-esm/mock/types.js

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

package/build-tsc-esm/packageDetect.js

@@ -1,4 +0,0 @@
-import { packageInfo as typesInfo } from '@pezkuwi/types/packageInfo';
-import { detectPackage } from '@pezkuwi/util';
-import { packageInfo } from './packageInfo.js';
-detectPackage(packageInfo, null, [typesInfo]);

package/build-tsc-esm/packageInfo.js

@@ -1 +0,0 @@
-export const packageInfo = { name: '@pezkuwi/rpc-provider', 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: '16.5.8' };

package/build-tsc-esm/types.js

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