@pezkuwi/rpc-provider 16.5.5 → 16.5.8

package/bizinikiwi-connect/index.js

@@ -0,0 +1,319 @@
+import { EventEmitter } from 'eventemitter3';
+import { isError, isFunction, isObject, logger, noop, objectSpread } from '@pezkuwi/util';
+import { RpcCoder } from '../coder/index.js';
+import { healthChecker } from './Health.js';
+const l = logger('api-bizinikiwi-connect');
+const subscriptionUnsubscriptionMethods = new Map([
+    ['author_submitAndWatchExtrinsic', 'author_unwatchExtrinsic'],
+    ['chain_subscribeAllHeads', 'chain_unsubscribeAllHeads'],
+    ['chain_subscribeFinalizedHeads', 'chain_unsubscribeFinalizedHeads'],
+    ['chain_subscribeFinalisedHeads', 'chain_subscribeFinalisedHeads'],
+    ['chain_subscribeNewHeads', 'chain_unsubscribeNewHeads'],
+    ['chain_subscribeNewHead', 'chain_unsubscribeNewHead'],
+    ['chain_subscribeRuntimeVersion', 'chain_unsubscribeRuntimeVersion'],
+    ['subscribe_newHead', 'unsubscribe_newHead'],
+    ['state_subscribeRuntimeVersion', 'state_unsubscribeRuntimeVersion'],
+    ['state_subscribeStorage', 'state_unsubscribeStorage']
+]);
+const scClients = new WeakMap();
+export class ScProvider {
+    #Sc;
+    #coder = new RpcCoder();
+    #spec;
+    #sharedSandbox;
+    #subscriptions = new Map();
+    #resubscribeMethods = new Map();
+    #requests = new Map();
+    #wellKnownChains;
+    #eventemitter = new EventEmitter();
+    #chain = null;
+    #isChainReady = false;
+    constructor(Sc, spec, sharedSandbox) {
+        if (!isObject(Sc) || !isObject(Sc.WellKnownChain) || !isFunction(Sc.createScClient)) {
+            throw new Error('Expected an @bizinikiwi/connect interface as first parameter to ScProvider');
+        }
+        this.#Sc = Sc;
+        this.#spec = spec;
+        this.#sharedSandbox = sharedSandbox;
+        this.#wellKnownChains = new Set(Object.values(Sc.WellKnownChain));
+    }
+    get hasSubscriptions() {
+        // Indicates that subscriptions are supported
+        return !!true;
+    }
+    get isClonable() {
+        return !!false;
+    }
+    get isConnected() {
+        return !!this.#chain && this.#isChainReady;
+    }
+    clone() {
+        throw new Error('clone() is not supported.');
+    }
+    // Config details can be found in @bizinikiwi/connect repo following the link:
+    // https://github.com/pezkuwichain/bizinikiwi-connect/blob/main/packages/connect/src/connector/index.ts
+    async connect(config, checkerFactory = healthChecker) {
+        if (this.isConnected) {
+            throw new Error('Already connected!');
+        }
+        // it could happen that after emitting `disconnected` due to the fact that
+        // smoldot is syncing, the consumer tries to reconnect after a certain amount
+        // of time... In which case we want to make sure that we don't create a new
+        // chain.
+        if (this.#chain) {
+            await this.#chain;
+            return;
+        }
+        if (this.#sharedSandbox && !this.#sharedSandbox.isConnected) {
+            await this.#sharedSandbox.connect();
+        }
+        const client = this.#sharedSandbox
+            ? scClients.get(this.#sharedSandbox)
+            : this.#Sc.createScClient(config);
+        if (!client) {
+            throw new Error('Unknown ScProvider!');
+        }
+        scClients.set(this, client);
+        const hc = checkerFactory();
+        const onResponse = (res) => {
+            const hcRes = hc.responsePassThrough(res);
+            if (!hcRes) {
+                return;
+            }
+            const response = JSON.parse(hcRes);
+            let decodedResponse;
+            try {
+                decodedResponse = this.#coder.decodeResponse(response);
+            }
+            catch (e) {
+                decodedResponse = e;
+            }
+            // It's not a subscription message, but rather a standar RPC response
+            if (response.params?.subscription === undefined || !response.method) {
+                return this.#requests.get(response.id)?.(decodedResponse);
+            }
+            // We are dealing with a subscription message
+            const subscriptionId = `${response.method}::${response.params.subscription}`;
+            const callback = this.#subscriptions.get(subscriptionId)?.[0];
+            callback?.(decodedResponse);
+        };
+        const addChain = this.#sharedSandbox
+            ? (async (...args) => {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                const source = this.#sharedSandbox;
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                return (await source.#chain).addChain(...args);
+            })
+            : this.#wellKnownChains.has(this.#spec)
+                ? client.addWellKnownChain
+                : client.addChain;
+        this.#chain = addChain(this.#spec).then((chain) => {
+            hc.setSendJsonRpc(chain.sendJsonRpc);
+            // Start async response processing loop
+            // This replaces the callback-based API from older @substrate/connect versions
+            (async () => {
+                try {
+                    for await (const res of chain.jsonRpcResponses) {
+                        onResponse(res);
+                    }
+                }
+                catch {
+                    // Chain was removed or connection closed - this is expected
+                }
+            })();
+            this.#isChainReady = false;
+            const cleanup = () => {
+                // If there are any callbacks left, we have to reject/error them.
+                // Otherwise, that would cause a memory leak.
+                const disconnectionError = new Error('Disconnected');
+                this.#requests.forEach((cb) => cb(disconnectionError));
+                this.#subscriptions.forEach(([cb]) => cb(disconnectionError));
+                this.#subscriptions.clear();
+            };
+            const staleSubscriptions = [];
+            const killStaleSubscriptions = () => {
+                if (staleSubscriptions.length === 0) {
+                    return;
+                }
+                const stale = staleSubscriptions.pop();
+                if (!stale) {
+                    throw new Error('Unable to get stale subscription');
+                }
+                const { id, unsubscribeMethod } = stale;
+                Promise
+                    .race([
+                    this.send(unsubscribeMethod, [id]).catch(noop),
+                    new Promise((resolve) => setTimeout(resolve, 500))
+                ])
+                    .then(killStaleSubscriptions)
+                    .catch(noop);
+            };
+            hc.start((health) => {
+                const isReady = !health.isSyncing && (health.peers > 0 || !health.shouldHavePeers);
+                // if it's the same as before, then nothing has changed and we are done
+                if (this.#isChainReady === isReady) {
+                    return;
+                }
+                this.#isChainReady = isReady;
+                if (!isReady) {
+                    // If we've reached this point, that means that the chain used to be "ready"
+                    // and now we are about to emit `disconnected`.
+                    //
+                    // This will cause the PezkuwiJs API think that the connection is
+                    // actually dead. In reality the smoldot chain is not dead, of course.
+                    // However, we have to cleanup all the existing callbacks because when
+                    // the smoldot chain stops syncing, then we will emit `connected` and
+                    // the PezkuwiJs API will try to re-create the previous
+                    // subscriptions and requests. Although, now is not a good moment
+                    // to be sending unsubscription messages to the smoldot chain, we
+                    // should wait until is no longer syncing to send the unsubscription
+                    // messages from the stale subscriptions of the previous connection.
+                    //
+                    // That's why -before we perform the cleanup of `this.#subscriptions`-
+                    // we keep the necessary information that we will need later on to
+                    // kill the stale subscriptions.
+                    [...this.#subscriptions.values()].forEach((s) => {
+                        staleSubscriptions.push(s[1]);
+                    });
+                    cleanup();
+                    this.#eventemitter.emit('disconnected');
+                }
+                else {
+                    killStaleSubscriptions();
+                    this.#eventemitter.emit('connected');
+                    if (this.#resubscribeMethods.size) {
+                        this.#resubscribe();
+                    }
+                }
+            });
+            return objectSpread({}, chain, {
+                remove: () => {
+                    hc.stop();
+                    chain.remove();
+                    cleanup();
+                },
+                sendJsonRpc: hc.sendJsonRpc.bind(hc)
+            });
+        });
+        try {
+            await this.#chain;
+        }
+        catch (e) {
+            this.#chain = null;
+            this.#eventemitter.emit('error', e);
+            throw e;
+        }
+    }
+    #resubscribe = () => {
+        const promises = [];
+        this.#resubscribeMethods.forEach((subDetails) => {
+            // only re-create subscriptions which are not in author (only area where
+            // transactions are created, i.e. submissions such as 'author_submitAndWatchExtrinsic'
+            // are not included (and will not be re-broadcast)
+            if (subDetails.type.startsWith('author_')) {
+                return;
+            }
+            try {
+                const promise = new Promise((resolve) => {
+                    this.subscribe(subDetails.type, subDetails.method, subDetails.params, subDetails.callback).catch((error) => console.log(error));
+                    resolve();
+                });
+                promises.push(promise);
+            }
+            catch (error) {
+                l.error(error);
+            }
+        });
+        Promise.all(promises).catch((err) => l.log(err));
+    };
+    async disconnect() {
+        if (!this.#chain) {
+            return;
+        }
+        const chain = await this.#chain;
+        this.#chain = null;
+        this.#isChainReady = false;
+        try {
+            chain.remove();
+        }
+        catch (_) { }
+        this.#eventemitter.emit('disconnected');
+    }
+    on(type, sub) {
+        // It's possible. Although, quite unlikely, that by the time that pezkuwi
+        // subscribes to the `connected` event, the Provider is already connected.
+        // In that case, we must emit to let the consumer know that we are connected.
+        if (type === 'connected' && this.isConnected) {
+            sub();
+        }
+        this.#eventemitter.on(type, sub);
+        return () => {
+            this.#eventemitter.removeListener(type, sub);
+        };
+    }
+    async send(method, params) {
+        if (!this.isConnected || !this.#chain) {
+            throw new Error('Provider is not connected');
+        }
+        const chain = await this.#chain;
+        const [id, json] = this.#coder.encodeJson(method, params);
+        const result = new Promise((resolve, reject) => {
+            this.#requests.set(id, (response) => {
+                (isError(response) ? reject : resolve)(response);
+            });
+            try {
+                chain.sendJsonRpc(json);
+            }
+            catch (e) {
+                this.#chain = null;
+                try {
+                    chain.remove();
+                }
+                catch (_) { }
+                this.#eventemitter.emit('error', e);
+            }
+        });
+        try {
+            return await result;
+        }
+        finally {
+            // let's ensure that once the Promise is resolved/rejected, then we remove
+            // remove its entry from the internal #requests
+            this.#requests.delete(id);
+        }
+    }
+    async subscribe(type, method, params, callback) {
+        if (!subscriptionUnsubscriptionMethods.has(method)) {
+            throw new Error(`Unsupported subscribe method: ${method}`);
+        }
+        const id = await this.send(method, params);
+        const subscriptionId = `${type}::${id}`;
+        const cb = (response) => {
+            if (response instanceof Error) {
+                callback(response, undefined);
+            }
+            else {
+                callback(null, response);
+            }
+        };
+        const unsubscribeMethod = subscriptionUnsubscriptionMethods.get(method);
+        if (!unsubscribeMethod) {
+            throw new Error('Invalid unsubscribe method found');
+        }
+        this.#resubscribeMethods.set(subscriptionId, { callback, method, params, type });
+        this.#subscriptions.set(subscriptionId, [cb, { id, unsubscribeMethod }]);
+        return id;
+    }
+    unsubscribe(type, method, id) {
+        if (!this.isConnected) {
+            throw new Error('Provider is not connected');
+        }
+        const subscriptionId = `${type}::${id}`;
+        if (!this.#subscriptions.has(subscriptionId)) {
+            return Promise.reject(new Error(`Unable to find active subscription=${subscriptionId}`));
+        }
+        this.#resubscribeMethods.delete(subscriptionId);
+        this.#subscriptions.delete(subscriptionId);
+        return this.send(method, [id]);
+    }
+}

package/bizinikiwi-connect/types.js

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

package/build/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/build/README.md

@@ -0,0 +1,68 @@
+# @pezkuwi/rpc-provider
+
+Generic transport providers to handle the transport of method calls to and from Pezkuwi clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.
+
+## Provider Selection
+
+There are three flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets, and the third one uses bizinikiwi light-client through @bizinikiwi/connect. It is generally recommended to use the [[WsProvider]] since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.
+
+All providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection.
+
+## Usage
+
+Installation -
+
+```
+yarn add @pezkuwi/rpc-provider
+```
+
+WebSocket Initialization -
+
+```javascript
+import { WsProvider } from '@pezkuwi/rpc-provider';
+
+// this is the actual default endpoint
+const provider = new WsProvider('ws://127.0.0.1:9944');
+const version = await provider.send('client_version', []);
+
+console.log('client version', version);
+```
+
+HTTP Initialization -
+
+```javascript
+import { HttpProvider } from '@pezkuwi/rpc-provider';
+
+// this is the actual default endpoint
+const provider = new HttpProvider('http://127.0.0.1:9933');
+const version = await provider.send('chain_getBlockHash', []);
+
+console.log('latest block Hash', hash);
+```
+
+@bizinikiwi/connect Initialization -
+
+Instantiating a Provider for the Pezkuwi Relay Chain:
+```javascript
+import { ScProvider } from '@pezkuwi/rpc-provider';
+import * as Sc from '@bizinikiwi/connect';
+
+const provider = new ScProvider(Sc, Sc.WellKnownChain.pezkuwi);
+
+await provider.connect();
+
+const version = await provider.send('chain_getBlockHash', []);
+```
+
+Instantiating a Provider for a Pezkuwi teyrchain:
+```javascript
+import { ScProvider } from '@pezkuwi/rpc-provider';
+import * as Sc from '@bizinikiwi/connect';
+
+const pezkuwiProvider = new ScProvider(Sc, Sc.WellKnownChain.pezkuwi);
+const teyrchainProvider = new ScProvider(Sc, teyrchainSpec, pezkuwiProvider);
+
+await teyrchainProvider.connect();
+
+const version = await teyrchainProvider.send('chain_getBlockHash', []);
+```

package/build/bizinikiwi-connect/Health.d.ts

@@ -0,0 +1,7 @@
+import type { HealthChecker } from './types.js';
+export declare function healthChecker(): HealthChecker;
+export declare class HealthCheckError extends Error {
+    #private;
+    getCause(): unknown;
+    constructor(response: unknown, message?: string);
+}