@pezkuwi/rpc-provider 16.5.16 → 16.5.18

package/build/mock/mockHttp.js

@@ -0,0 +1,12 @@
+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/mock/mockWs.d.ts

@@ -0,0 +1,26 @@
+import { Server } from 'mock-socket';
+interface Scope {
+    body: Record<string, Record<string, unknown>>;
+    requests: number;
+    server: Server;
+    done: any;
+}
+interface ErrorDef {
+    id: number;
+    error: {
+        code: number;
+        message: string;
+    };
+}
+interface ReplyDef {
+    id: number;
+    reply: {
+        result: unknown;
+    };
+}
+export type Request = {
+    method: string;
+} & (ErrorDef | ReplyDef);
+export declare const TEST_WS_URL = "ws://localhost:9955";
+export declare function mockWs(requests: Request[], wsUrl?: string): Scope;
+export {};

package/build/mock/mockWs.js

@@ -0,0 +1,43 @@
+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/mock/types.d.ts

@@ -0,0 +1,23 @@
+import type { Server } from 'mock-socket';
+export type Global = typeof globalThis & {
+    WebSocket: typeof WebSocket;
+    fetch: any;
+};
+export interface Mock {
+    body: Record<string, Record<string, unknown>>;
+    requests: number;
+    server: Server;
+    done: () => Promise<void>;
+}
+export type MockStateSubscriptionCallback = (error: Error | null, value: any) => void;
+export interface MockStateSubscription {
+    callbacks: Record<number, MockStateSubscriptionCallback>;
+    lastValue: any;
+}
+export interface MockStateSubscriptions {
+    chain_subscribeNewHead: MockStateSubscription;
+    state_subscribeStorage: MockStateSubscription;
+    [key: string]: MockStateSubscription;
+}
+export type MockStateDb = Record<string, Uint8Array>;
+export type MockStateRequests = Record<string, (db: MockStateDb, params: any[]) => string>;

package/build/mock/types.js

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

package/build/package.json

@@ -0,0 +1,344 @@
+{
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "bugs": "https://github.com/pezkuwichain/pezkuwi-api/issues",
+  "description": "Transport providers for the API",
+  "engines": {
+    "node": ">=18"
+  },
+  "homepage": "https://github.com/pezkuwichain/pezkuwi-api/tree/master/packages/rpc-provider#readme",
+  "license": "Apache-2.0",
+  "name": "@pezkuwi/rpc-provider",
+  "repository": {
+    "directory": "packages/rpc-provider",
+    "type": "git",
+    "url": "https://github.com/pezkuwichain/pezkuwi-api.git"
+  },
+  "sideEffects": [
+    "./packageDetect.js",
+    "./cjs/packageDetect.js"
+  ],
+  "type": "module",
+  "version": "16.5.18",
+  "main": "./cjs/index.js",
+  "module": "./cjs/index.js",
+  "types": "./cjs/index.d.ts",
+  "exports": {
+    "./cjs/package.json": "./cjs/package.json",
+    "./cjs/*": "./cjs/*.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"
+      }
+    },
+    "./bizinikiwi-connect": {
+      "module": {
+        "types": "./bizinikiwi-connect/index.d.ts",
+        "default": "./bizinikiwi-connect/index.js"
+      },
+      "require": {
+        "types": "./cjs/bizinikiwi-connect/index.d.ts",
+        "default": "./cjs/bizinikiwi-connect/index.js"
+      },
+      "default": {
+        "types": "./bizinikiwi-connect/index.d.ts",
+        "default": "./bizinikiwi-connect/index.js"
+      }
+    },
+    "./bizinikiwi-connect/Health": {
+      "module": {
+        "types": "./bizinikiwi-connect/Health.d.ts",
+        "default": "./bizinikiwi-connect/Health.js"
+      },
+      "require": {
+        "types": "./cjs/bizinikiwi-connect/Health.d.ts",
+        "default": "./cjs/bizinikiwi-connect/Health.js"
+      },
+      "default": {
+        "types": "./bizinikiwi-connect/Health.d.ts",
+        "default": "./bizinikiwi-connect/Health.js"
+      }
+    },
+    "./bizinikiwi-connect/types": {
+      "module": {
+        "types": "./bizinikiwi-connect/types.d.ts",
+        "default": "./bizinikiwi-connect/types.js"
+      },
+      "require": {
+        "types": "./cjs/bizinikiwi-connect/types.d.ts",
+        "default": "./cjs/bizinikiwi-connect/types.js"
+      },
+      "default": {
+        "types": "./bizinikiwi-connect/types.d.ts",
+        "default": "./bizinikiwi-connect/types.js"
+      }
+    },
+    "./bundle": {
+      "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"
+      }
+    },
+    "./coder": {
+      "module": {
+        "types": "./coder/index.d.ts",
+        "default": "./coder/index.js"
+      },
+      "require": {
+        "types": "./cjs/coder/index.d.ts",
+        "default": "./cjs/coder/index.js"
+      },
+      "default": {
+        "types": "./coder/index.d.ts",
+        "default": "./coder/index.js"
+      }
+    },
+    "./coder/error": {
+      "module": {
+        "types": "./coder/error.d.ts",
+        "default": "./coder/error.js"
+      },
+      "require": {
+        "types": "./cjs/coder/error.d.ts",
+        "default": "./cjs/coder/error.js"
+      },
+      "default": {
+        "types": "./coder/error.d.ts",
+        "default": "./coder/error.js"
+      }
+    },
+    "./defaults": {
+      "module": {
+        "types": "./defaults.d.ts",
+        "default": "./defaults.js"
+      },
+      "require": {
+        "types": "./cjs/defaults.d.ts",
+        "default": "./cjs/defaults.js"
+      },
+      "default": {
+        "types": "./defaults.d.ts",
+        "default": "./defaults.js"
+      }
+    },
+    "./http": {
+      "module": {
+        "types": "./http/index.d.ts",
+        "default": "./http/index.js"
+      },
+      "require": {
+        "types": "./cjs/http/index.d.ts",
+        "default": "./cjs/http/index.js"
+      },
+      "default": {
+        "types": "./http/index.d.ts",
+        "default": "./http/index.js"
+      }
+    },
+    "./http/types": {
+      "module": {
+        "types": "./http/types.d.ts",
+        "default": "./http/types.js"
+      },
+      "require": {
+        "types": "./cjs/http/types.d.ts",
+        "default": "./cjs/http/types.js"
+      },
+      "default": {
+        "types": "./http/types.d.ts",
+        "default": "./http/types.js"
+      }
+    },
+    "./lru": {
+      "module": {
+        "types": "./lru.d.ts",
+        "default": "./lru.js"
+      },
+      "require": {
+        "types": "./cjs/lru.d.ts",
+        "default": "./cjs/lru.js"
+      },
+      "default": {
+        "types": "./lru.d.ts",
+        "default": "./lru.js"
+      }
+    },
+    "./mock": {
+      "module": {
+        "types": "./mock/index.d.ts",
+        "default": "./mock/index.js"
+      },
+      "require": {
+        "types": "./cjs/mock/index.d.ts",
+        "default": "./cjs/mock/index.js"
+      },
+      "default": {
+        "types": "./mock/index.d.ts",
+        "default": "./mock/index.js"
+      }
+    },
+    "./mock/mockHttp": {
+      "module": {
+        "types": "./mock/mockHttp.d.ts",
+        "default": "./mock/mockHttp.js"
+      },
+      "require": {
+        "types": "./cjs/mock/mockHttp.d.ts",
+        "default": "./cjs/mock/mockHttp.js"
+      },
+      "default": {
+        "types": "./mock/mockHttp.d.ts",
+        "default": "./mock/mockHttp.js"
+      }
+    },
+    "./mock/mockWs": {
+      "module": {
+        "types": "./mock/mockWs.d.ts",
+        "default": "./mock/mockWs.js"
+      },
+      "require": {
+        "types": "./cjs/mock/mockWs.d.ts",
+        "default": "./cjs/mock/mockWs.js"
+      },
+      "default": {
+        "types": "./mock/mockWs.d.ts",
+        "default": "./mock/mockWs.js"
+      }
+    },
+    "./mock/types": {
+      "module": {
+        "types": "./mock/types.d.ts",
+        "default": "./mock/types.js"
+      },
+      "require": {
+        "types": "./cjs/mock/types.d.ts",
+        "default": "./cjs/mock/types.js"
+      },
+      "default": {
+        "types": "./mock/types.d.ts",
+        "default": "./mock/types.js"
+      }
+    },
+    "./package.json": {
+      "require": "./cjs/package.json",
+      "default": "./package.json"
+    },
+    "./packageDetect": {
+      "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": {
+      "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": {
+      "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": {
+      "module": {
+        "types": "./types.d.ts",
+        "default": "./types.js"
+      },
+      "require": {
+        "types": "./cjs/types.d.ts",
+        "default": "./cjs/types.js"
+      },
+      "default": {
+        "types": "./types.d.ts",
+        "default": "./types.js"
+      }
+    },
+    "./ws": {
+      "module": {
+        "types": "./ws/index.d.ts",
+        "default": "./ws/index.js"
+      },
+      "require": {
+        "types": "./cjs/ws/index.d.ts",
+        "default": "./cjs/ws/index.js"
+      },
+      "default": {
+        "types": "./ws/index.d.ts",
+        "default": "./ws/index.js"
+      }
+    },
+    "./ws/errors": {
+      "module": {
+        "types": "./ws/errors.d.ts",
+        "default": "./ws/errors.js"
+      },
+      "require": {
+        "types": "./cjs/ws/errors.d.ts",
+        "default": "./cjs/ws/errors.js"
+      },
+      "default": {
+        "types": "./ws/errors.d.ts",
+        "default": "./ws/errors.js"
+      }
+    }
+  },
+  "dependencies": {
+    "@pezkuwi/keyring": "14.0.11",
+    "@pezkuwi/types": "16.5.9",
+    "@pezkuwi/types-support": "16.5.9",
+    "@pezkuwi/util": "14.0.11",
+    "@pezkuwi/util-crypto": "14.0.11",
+    "@pezkuwi/x-fetch": "14.0.11",
+    "@pezkuwi/x-global": "14.0.11",
+    "@pezkuwi/x-ws": "14.0.11",
+    "eventemitter3": "^5.0.1",
+    "mock-socket": "^9.3.1",
+    "nock": "^13.5.5",
+    "tslib": "^2.8.1"
+  },
+  "optionalDependencies": {
+    "@bizinikiwi/connect": "2.1.9"
+  }
+}

package/build/packageDetect.d.ts

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

package/build/packageDetect.js

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

package/build/packageInfo.d.ts

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

package/build/packageInfo.js

@@ -0,0 +1 @@
+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.18' };

package/build/types.d.ts

@@ -0,0 +1,85 @@
+export interface JsonRpcObject {
+    id: number;
+    jsonrpc: '2.0';
+}
+export interface JsonRpcRequest extends JsonRpcObject {
+    method: string;
+    params: unknown[];
+}
+export interface JsonRpcResponseBaseError {
+    code: number;
+    data?: number | string;
+    message: string;
+}
+export interface RpcErrorInterface<T> {
+    code: number;
+    data?: T;
+    message: string;
+    stack: string;
+}
+interface JsonRpcResponseSingle<T> {
+    error?: JsonRpcResponseBaseError;
+    result: T;
+}
+interface JsonRpcResponseSubscription<T> {
+    method?: string;
+    params: {
+        error?: JsonRpcResponseBaseError;
+        result: T;
+        subscription: number | string;
+    };
+}
+export type JsonRpcResponseBase<T> = JsonRpcResponseSingle<T> & JsonRpcResponseSubscription<T>;
+export type JsonRpcResponse<T> = JsonRpcObject & JsonRpcResponseBase<T>;
+export type ProviderInterfaceCallback = (error: Error | null, result: any) => void;
+export type ProviderInterfaceEmitted = 'connected' | 'disconnected' | 'error';
+export type ProviderInterfaceEmitCb = (value?: any) => any;
+export interface ProviderInterface {
+    /** true if the provider supports subscriptions (not available for HTTP) */
+    readonly hasSubscriptions: boolean;
+    /** true if the clone() functionality is available on the provider */
+    readonly isClonable: boolean;
+    /** true if the provider is currently connected (ws/sc has connection logic) */
+    readonly isConnected: boolean;
+    /** (optional) stats for the provider with connections/bytes */
+    readonly stats?: ProviderStats;
+    /** (optional) stats for the provider with connections/bytes */
+    readonly ttl?: number | null;
+    clone(): ProviderInterface;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    on(type: ProviderInterfaceEmitted, sub: ProviderInterfaceEmitCb): () => void;
+    send<T = any>(method: string, params: unknown[], isCacheable?: boolean): Promise<T>;
+    subscribe(type: string, method: string, params: unknown[], cb: ProviderInterfaceCallback): Promise<number | string>;
+    unsubscribe(type: string, method: string, id: number | string): Promise<boolean>;
+}
+/** Stats for a specific endpoint */
+export interface EndpointStats {
+    /** The total number of bytes sent */
+    bytesRecv: number;
+    /** The total number of bytes received */
+    bytesSent: number;
+    /** The number of cached/in-progress requests made */
+    cached: number;
+    /** The number of errors found */
+    errors: number;
+    /** The number of requests */
+    requests: number;
+    /** The number of subscriptions */
+    subscriptions: number;
+    /** The number of request timeouts */
+    timeout: number;
+}
+/** Overall stats for the provider */
+export interface ProviderStats {
+    /** Details for the active/open requests */
+    active: {
+        /** Number of active requests */
+        requests: number;
+        /** Number of active subscriptions */
+        subscriptions: number;
+    };
+    /** The total requests that have been made */
+    total: EndpointStats;
+}
+export {};

package/build/types.js

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

package/build/ws/errors.d.ts

@@ -0,0 +1 @@
+export declare function getWSErrorString(code: number): string;

package/build/ws/errors.js

@@ -0,0 +1,38 @@
+const known = {
+    1000: 'Normal Closure',
+    1001: 'Going Away',
+    1002: 'Protocol Error',
+    1003: 'Unsupported Data',
+    1004: '(For future)',
+    1005: 'No Status Received',
+    1006: 'Abnormal Closure',
+    1007: 'Invalid frame payload data',
+    1008: 'Policy Violation',
+    1009: 'Message too big',
+    1010: 'Missing Extension',
+    1011: 'Internal Error',
+    1012: 'Service Restart',
+    1013: 'Try Again Later',
+    1014: 'Bad Gateway',
+    1015: 'TLS Handshake'
+};
+export function getWSErrorString(code) {
+    if (code >= 0 && code <= 999) {
+        return '(Unused)';
+    }
+    else if (code >= 1016) {
+        if (code <= 1999) {
+            return '(For WebSocket standard)';
+        }
+        else if (code <= 2999) {
+            return '(For WebSocket extensions)';
+        }
+        else if (code <= 3999) {
+            return '(For libraries and frameworks)';
+        }
+        else if (code <= 4999) {
+            return '(For applications)';
+        }
+    }
+    return known[code] || '(Unknown)';
+}