@pezkuwi/api 16.5.6 → 16.5.8

package/build-tsc-esm/base/find.js

@@ -0,0 +1,7 @@
+import { u8aToU8a } from '@pezkuwi/util';
+export function findCall(registry, callIndex) {
+    return registry.findMetaCall(u8aToU8a(callIndex));
+}
+export function findError(registry, errorIndex) {
+    return registry.findMetaError(u8aToU8a(errorIndex));
+}

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

@@ -0,0 +1,57 @@
+import { isString, objectSpread, u8aToHex, u8aToU8a } from '@pezkuwi/util';
+import { Getters } from './Getters.js';
+export class ApiBase extends Getters {
+    /**
+     * @description Create an instance of the class
+     *
+     * @param options Options object to create API instance or a Provider instance
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * import Api from '@pezkuwi/api/promise';
+     *
+     * const api = new Api().isReady();
+     *
+     * api.rpc.subscribeNewHeads((header) => {
+     *   console.log(`new block #${header.number.toNumber()}`);
+     * });
+     * ```
+     */
+    constructor(options = {}, type, decorateMethod) {
+        super(options, type, decorateMethod);
+    }
+    /**
+     * @description Connect from the underlying provider, halting all network traffic
+     */
+    connect() {
+        return this._rpcCore.connect();
+    }
+    /**
+     * @description Disconnect from the underlying provider, halting all network traffic
+     */
+    disconnect() {
+        this._unsubscribe();
+        return this._rpcCore.disconnect();
+    }
+    /**
+     * @description Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair
+     */
+    setSigner(signer) {
+        this._rx.signer = signer;
+    }
+    /**
+     * @description Signs a raw signer payload, string or Uint8Array
+     */
+    async sign(address, data, { signer } = {}) {
+        if (isString(address)) {
+            const _signer = signer || this._rx.signer;
+            if (!_signer?.signRaw) {
+                throw new Error('No signer exists with a signRaw interface. You possibly need to pass through an explicit keypair for the origin so it can be used for signing.');
+            }
+            return (await _signer.signRaw(objectSpread({ type: 'bytes' }, data, { address }))).signature;
+        }
+        return u8aToHex(address.sign(u8aToU8a(data.data)));
+    }
+}

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

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

package/build-tsc-esm/bundle.js

@@ -0,0 +1,7 @@
+import '@pezkuwi/rpc-augment';
+export { Keyring } from '@pezkuwi/keyring';
+export { HttpProvider, ScProvider, WsProvider } from '@pezkuwi/rpc-provider';
+export { packageInfo } from './packageInfo.js';
+export { SubmittableResult } from './submittable/index.js';
+export * from './promise/index.js';
+export * from './rx/index.js';

package/build-tsc-esm/index.js

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

package/build-tsc-esm/packageDetect.js

@@ -0,0 +1,8 @@
+import { packageInfo as deriveInfo } from '@pezkuwi/api-derive/packageInfo';
+import { packageInfo as coreInfo } from '@pezkuwi/rpc-core/packageInfo';
+import { packageInfo as providerInfo } from '@pezkuwi/rpc-provider/packageInfo';
+import { packageInfo as typesInfo } from '@pezkuwi/types/packageInfo';
+import { packageInfo as knownInfo } from '@pezkuwi/types-known/packageInfo';
+import { detectPackage } from '@pezkuwi/util';
+import { packageInfo } from './packageInfo.js';
+detectPackage(packageInfo, null, [coreInfo, deriveInfo, knownInfo, providerInfo, typesInfo]);

package/build-tsc-esm/packageInfo.js

@@ -0,0 +1 @@
+export const packageInfo = { name: '@pezkuwi/api', 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/promise/Api.js

@@ -0,0 +1,191 @@
+import { noop, objectSpread } from '@pezkuwi/util';
+import { ApiBase } from '../base/index.js';
+import { Combinator } from './Combinator.js';
+import { promiseTracker, toPromiseMethod } from './decorateMethod.js';
+/**
+ * # @pezkuwi/api/promise
+ *
+ * ## Overview
+ *
+ * @name ApiPromise
+ * @description
+ * ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Pezkuwi network. As a full Promise-based, all interface calls return Promises, including the static `.create(...)`. Subscription calls utilise `(value) => {}` callbacks to pass through the latest values.
+ *
+ * The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Pezkuwi (and Bizinikiwi) clients.
+ *
+ * @see [[ApiRx]]
+ *
+ * ## Usage
+ *
+ * Making rpc calls -
+ * <BR>
+ *
+ * ```javascript
+ * import ApiPromise from '@pezkuwi/api/promise';
+ *
+ * // initialise via static create
+ * const api = await ApiPromise.create();
+ *
+ * // make a subscription to the network head
+ * api.rpc.chain.subscribeNewHeads((header) => {
+ *   console.log(`Chain is at #${header.number}`);
+ * });
+ * ```
+ * <BR>
+ *
+ * Subscribing to chain state -
+ * <BR>
+ *
+ * ```javascript
+ * import { ApiPromise, WsProvider } from '@pezkuwi/api';
+ *
+ * // initialise a provider with a specific endpoint
+ * const provider = new WsProvider('wss://example.com:9944')
+ *
+ * // initialise via isReady & new with specific provider
+ * const api = await new ApiPromise({ provider }).isReady;
+ *
+ * // retrieve the block target time
+ * const blockPeriod = await api.query.timestamp.blockPeriod().toNumber();
+ * let last = 0;
+ *
+ * // subscribe to the current block timestamp, updates automatically (callback provided)
+ * api.query.timestamp.now((timestamp) => {
+ *   const elapsed = last
+ *     ? `, ${timestamp.toNumber() - last}s since last`
+ *     : '';
+ *
+ *   last = timestamp.toNumber();
+ *   console.log(`timestamp ${timestamp}${elapsed} (${blockPeriod}s target)`);
+ * });
+ * ```
+ * <BR>
+ *
+ * Submitting a transaction -
+ * <BR>
+ *
+ * ```javascript
+ * import ApiPromise from '@pezkuwi/api/promise';
+ *
+ * ApiPromise.create().then((api) => {
+ *   const [nonce] = await api.query.system.account(keyring.alice.address);
+ *
+ *   api.tx.balances
+ *     // create transfer
+ *     transfer(keyring.bob.address, 12345)
+ *     // sign the transcation
+ *     .sign(keyring.alice, { nonce })
+ *     // send the transaction (optional status callback)
+ *     .send((status) => {
+ *       console.log(`current status ${status.type}`);
+ *     })
+ *     // retrieve the submitted extrinsic hash
+ *     .then((hash) => {
+ *       console.log(`submitted with hash ${hash}`);
+ *     });
+ * });
+ * ```
+ */
+export class ApiPromise extends ApiBase {
+    #isReadyPromise;
+    #isReadyOrErrorPromise;
+    /**
+     * @description Creates an instance of the ApiPromise class
+     * @param options Options to create an instance. This can be either [[ApiOptions]] or
+     * an [[WsProvider]].
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * import Api from '@pezkuwi/api/promise';
+     *
+     * new Api().isReady.then((api) => {
+     *   api.rpc.subscribeNewHeads((header) => {
+     *     console.log(`new block #${header.number.toNumber()}`);
+     *   });
+     * });
+     * ```
+     */
+    constructor(options) {
+        super(options, 'promise', toPromiseMethod);
+        this.#isReadyPromise = new Promise((resolve) => {
+            super.once('ready', () => resolve(this));
+        });
+        this.#isReadyOrErrorPromise = new Promise((resolve, reject) => {
+            const tracker = promiseTracker(resolve, reject);
+            super.once('ready', () => tracker.resolve(this));
+            super.once('error', (error) => tracker.reject(error));
+        });
+    }
+    /**
+     * @description Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.
+     * @param options options that is passed to the class contructor. Can be either [[ApiOptions]] or a
+     * provider (see the constructor arguments)
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * import Api from '@pezkuwi/api/promise';
+     *
+     * Api.create().then(async (api) => {
+     *   const timestamp = await api.query.timestamp.now();
+     *
+     *   console.log(`lastest block timestamp ${timestamp}`);
+     * });
+     * ```
+     */
+    static create(options) {
+        const instance = new ApiPromise(options);
+        if (options && options.throwOnConnect) {
+            return instance.isReadyOrError;
+        }
+        // Swallow any rejections on isReadyOrError
+        // (in Node 15.x this creates issues, when not being looked at)
+        instance.isReadyOrError.catch(noop);
+        return instance.isReady;
+    }
+    /**
+     * @description Promise that resolves the first time we are connected and loaded
+     */
+    get isReady() {
+        return this.#isReadyPromise;
+    }
+    /**
+     * @description Promise that resolves if we can connect, or reject if there is an error
+     */
+    get isReadyOrError() {
+        return this.#isReadyOrErrorPromise;
+    }
+    /**
+     * @description Returns a clone of this ApiPromise instance (new underlying provider connection)
+     */
+    clone() {
+        return new ApiPromise(objectSpread({}, this._options, { source: this }));
+    }
+    /**
+     * @description Creates a combinator that can be used to combine the latest results from multiple subscriptions
+     * @param fns An array of function to combine, each in the form of `(cb: (value: void)) => void`
+     * @param callback A callback that will return an Array of all the values this combinator has been applied to
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
+     *
+     * // combines values from balance & nonce as it updates
+     * api.combineLatest([
+     *   api.rpc.chain.subscribeNewHeads,
+     *   (cb) => api.query.system.account(address, cb)
+     * ], ([head, [balance, nonce]]) => {
+     *   console.log(`#${head.number}: You have ${balance.free} units, with ${nonce} transactions sent`);
+     * });
+     * ```
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async combineLatest(fns, callback) {
+        const combinator = new Combinator(fns, callback);
+        return () => {
+            combinator.unsubscribe();
+        };
+    }
+}

package/build-tsc-esm/promise/Combinator.js

@@ -0,0 +1,68 @@
+import { isFunction, noop } from '@pezkuwi/util';
+export class Combinator {
+    #allHasFired = false;
+    #callback;
+    #fired = [];
+    #fns = [];
+    #isActive = true;
+    #results = [];
+    #subscriptions = [];
+    constructor(fns, callback) {
+        this.#callback = callback;
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises, @typescript-eslint/require-await
+        this.#subscriptions = fns.map(async (input, index) => {
+            const [fn, ...args] = Array.isArray(input)
+                ? input
+                : [input];
+            this.#fired.push(false);
+            this.#fns.push(fn);
+            // Not quite 100% how to have a variable number at the front here
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return,@typescript-eslint/ban-types
+            return fn(...args, this._createCallback(index));
+        });
+    }
+    _allHasFired() {
+        this.#allHasFired ||= this.#fired.filter((hasFired) => !hasFired).length === 0;
+        return this.#allHasFired;
+    }
+    _createCallback(index) {
+        return (value) => {
+            this.#fired[index] = true;
+            this.#results[index] = value;
+            this._triggerUpdate();
+        };
+    }
+    _triggerUpdate() {
+        if (!this.#isActive || !isFunction(this.#callback) || !this._allHasFired()) {
+            return;
+        }
+        try {
+            Promise
+                .resolve(this.#callback(this.#results))
+                .catch(noop);
+        }
+        catch {
+            // swallow, we don't want the handler to trip us up
+        }
+    }
+    unsubscribe() {
+        if (!this.#isActive) {
+            return;
+        }
+        this.#isActive = false;
+        Promise
+            .all(this.#subscriptions.map(async (subscription) => {
+            try {
+                const unsubscribe = await subscription;
+                if (isFunction(unsubscribe)) {
+                    unsubscribe();
+                }
+            }
+            catch {
+                // ignore
+            }
+        })).catch(() => {
+            // ignore, already ignored above, should never throw
+        });
+    }
+}

package/build-tsc-esm/promise/decorateMethod.js

@@ -0,0 +1,71 @@
+import { catchError, EMPTY, tap } from 'rxjs';
+import { isFunction, nextTick } from '@pezkuwi/util';
+export function promiseTracker(resolve, reject) {
+    let isCompleted = false;
+    return {
+        reject: (error) => {
+            if (!isCompleted) {
+                isCompleted = true;
+                reject(error);
+            }
+            return EMPTY;
+        },
+        resolve: (value) => {
+            if (!isCompleted) {
+                isCompleted = true;
+                resolve(value);
+            }
+        }
+    };
+}
+function extractArgs(args, needsCallback) {
+    const actualArgs = args.slice();
+    // If the last arg is a function, we pop it, put it into callback.
+    // actualArgs will then hold the actual arguments to be passed to `method`
+    const callback = (args.length && isFunction(args[args.length - 1]))
+        ? actualArgs.pop()
+        : undefined;
+    // When we need a subscription, ensure that a valid callback is actually passed
+    if (needsCallback && !isFunction(callback)) {
+        throw new Error('Expected a callback to be passed with subscriptions');
+    }
+    return [actualArgs, callback];
+}
+function decorateCall(method, args) {
+    return new Promise((resolve, reject) => {
+        // single result tracker - either reject with Error or resolve with Codec result
+        const tracker = promiseTracker(resolve, reject);
+        // encoding errors reject immediately, any result unsubscribes and resolves
+        const subscription = method(...args)
+            .pipe(catchError((error) => tracker.reject(error)))
+            .subscribe((result) => {
+            tracker.resolve(result);
+            nextTick(() => subscription.unsubscribe());
+        });
+    });
+}
+function decorateSubscribe(method, args, resultCb) {
+    return new Promise((resolve, reject) => {
+        // either reject with error or resolve with unsubscribe callback
+        const tracker = promiseTracker(resolve, reject);
+        // errors reject immediately, the first result resolves with an unsubscribe promise, all results via callback
+        const subscription = method(...args)
+            .pipe(catchError((error) => tracker.reject(error)), tap(() => tracker.resolve(() => subscription.unsubscribe())))
+            .subscribe((result) => {
+            // queue result (back of queue to clear current)
+            nextTick(() => resultCb(result));
+        });
+    });
+}
+/**
+ * @description Decorate method for ApiPromise, where the results are converted to the Promise equivalent
+ */
+export function toPromiseMethod(method, options) {
+    const needsCallback = !!(options?.methodName && options.methodName.includes('subscribe'));
+    return function (...args) {
+        const [actualArgs, resultCb] = extractArgs(args, needsCallback);
+        return resultCb
+            ? decorateSubscribe(method, actualArgs, resultCb)
+            : decorateCall(options?.overrideNoSub || method, actualArgs);
+    };
+}

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

@@ -0,0 +1,2 @@
+export { ApiPromise } from './Api.js';
+export { toPromiseMethod } from './decorateMethod.js';

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

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

package/build-tsc-esm/rx/Api.js

@@ -0,0 +1,169 @@
+import { from } from 'rxjs';
+import { objectSpread } from '@pezkuwi/util';
+import { ApiBase } from '../base/index.js';
+import { toRxMethod } from './decorateMethod.js';
+/**
+ * # @pezkuwi/api/rx
+ *
+ * ## Overview
+ *
+ * @name ApiRx
+ *
+ * @description
+ * ApiRx is a powerful RxJS Observable wrapper around the RPC and interfaces on the Pezkuwi network. As a full Observable API, all interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion and subscription-based methods return long-running Observables that update with the latest values.
+ *
+ * The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Pezkuwi (and Bizinikiwi) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof.
+ *
+ * @see [[ApiPromise]]
+ *
+ * ## Usage
+ *
+ * Making rpc calls -
+ * <BR>
+ *
+ * ```javascript
+ * import ApiRx from '@pezkuwi/api/rx';
+ *
+ * // initialize via Promise & static create
+ * const api = await ApiRx.create().toPromise();
+ *
+ * // make a call to retrieve the current network head
+ * api.rpc.chain.subscribeNewHeads().subscribe((header) => {
+ *   console.log(`Chain is at #${header.number}`);
+ * });
+ * ```
+ * <BR>
+ *
+ * Subscribing to chain state -
+ * <BR>
+ *
+ * ```javascript
+ * import { combineLatest, pairwise, switchMap } from 'rxjs';
+ * import { ApiRx, WsProvider } from '@pezkuwi/api';
+ *
+ *
+ * // initialize a provider with a specific endpoint
+ * const provider = new WsProvider('wss://example.com:9944')
+ *
+ * // initialize via isReady & new with specific provider
+ * new ApiRx({ provider })
+ *   .isReady
+ *   .pipe(
+ *     switchMap((api) =>
+ *       combineLatest([
+ *         api.query.timestamp.blockPeriod(),
+ *         api.query.timestamp.now().pipe(pairwise())
+ *       ])
+ *     )
+ *   )
+ *   .subscribe(([blockPeriod, timestamp]) => {
+ *      const elapsed = timestamp[1].toNumber() - timestamp[0].toNumber();
+ *      console.log(`timestamp ${timestamp[1]} \nelapsed ${elapsed} \n(${blockPeriod}s target)`);
+ *   });
+ * ```
+ * <BR>
+ *
+ * Submitting a transaction -
+ * <BR>
+ *
+ * ```javascript
+ * import { first, switchMap } from 'rxjs';
+ * import ApiRx from '@pezkuwi/api/rx';
+ *
+ * // import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
+ * import testingPairs from '@pezkuwi/keyring/testingPairs';
+ * const keyring = testingPairs();
+ *
+ * // get api via Promise
+ * const api = await ApiRx.create().toPromise();
+ *
+ * // retrieve nonce for the account
+ * api.query.system
+ *   .account(keyring.alice.address)
+ *   .pipe(
+ *      first(),
+ *      // pipe nonce into transfer
+ *      switchMap(([nonce]) =>
+ *        api.tx.balances
+ *          // create transfer
+ *          .transferAllowDeath(keyring.bob.address, 12345)
+ *          // sign the transaction
+ *          .sign(keyring.alice, { nonce })
+ *          // send the transaction
+ *          .send()
+ *      )
+ *   )
+ *   // subscribe to overall result
+ *   .subscribe(({ status }) => {
+ *     if (status.isInBlock) {
+ *       console.log('Completed at block hash', status.asFinalized.toHex());
+ *     }
+ *   });
+ * ```
+ */
+export class ApiRx extends ApiBase {
+    #isReadyRx;
+    /**
+     * @description Create an instance of the ApiRx class
+     * @param options Options to create an instance. Can be either [[ApiOptions]] or [[WsProvider]]
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * import { switchMap } from 'rxjs';
+     * import Api from '@pezkuwi/api/rx';
+     *
+     * new Api().isReady
+     *   .pipe(
+     *     switchMap((api) =>
+     *       api.rpc.chain.subscribeNewHeads()
+     *   ))
+     *   .subscribe((header) => {
+     *     console.log(`new block #${header.number.toNumber()}`);
+     *   });
+     * ```
+     */
+    constructor(options) {
+        super(options, 'rxjs', toRxMethod);
+        this.#isReadyRx = from(
+        // You can create an observable from an event, however my mind groks this form better
+        new Promise((resolve) => {
+            super.on('ready', () => resolve(this));
+        }));
+    }
+    /**
+     * @description Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.
+     * @param options options that is passed to the class constructor. Can be either [[ApiOptions]] or [[WsProvider]]
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * import { switchMap } from 'rxjs';
+     * import Api from '@pezkuwi/api/rx';
+     *
+     * Api.create()
+     *   .pipe(
+     *     switchMap((api) =>
+     *       api.rpc.chain.subscribeNewHeads()
+     *   ))
+     *   .subscribe((header) => {
+     *     console.log(`new block #${header.number.toNumber()}`);
+     *   });
+     * ```
+     */
+    static create(options) {
+        return new ApiRx(options).isReady;
+    }
+    /**
+     * @description Observable that returns the first time we are connected and loaded
+     */
+    get isReady() {
+        return this.#isReadyRx;
+    }
+    /**
+     * @description Returns a clone of this ApiRx instance (new underlying provider connection)
+     */
+    clone() {
+        return new ApiRx(objectSpread({}, this._options, { source: this }));
+    }
+}

package/build-tsc-esm/rx/decorateMethod.js

@@ -0,0 +1,3 @@
+export function toRxMethod(method) {
+    return method;
+}

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

@@ -0,0 +1,2 @@
+export { ApiRx } from './Api.js';
+export { toRxMethod } from './decorateMethod.js';