@pezkuwi/api 16.5.5 → 16.5.6

package/cjs/base/Events.d.ts

@@ -0,0 +1,67 @@
+import type { ApiInterfaceEvents } from '../types/index.js';
+export declare class Events {
+    #private;
+    protected emit(type: ApiInterfaceEvents, ...args: unknown[]): boolean;
+    /**
+     * @description Attach an eventemitter handler to listen to a specific event
+     *
+     * @param type The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
+     * @param handler The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.on('connected', (): void => {
+     *   console.log('API has been connected to the endpoint');
+     * });
+     *
+     * api.on('disconnected', (): void => {
+     *   console.log('API has been disconnected from the endpoint');
+     * });
+     * ```
+     */
+    on(type: ApiInterfaceEvents, handler: (...args: any[]) => any): this;
+    /**
+     * @description Remove the given eventemitter handler
+     *
+     * @param type The type of event the callback was attached to. Available events are `connected`, `disconnected`, `ready` and `error`
+     * @param handler The callback to unregister.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * const handler = (): void => {
+     *  console.log('Connected !);
+     * };
+     *
+     * // Start listening
+     * api.on('connected', handler);
+     *
+     * // Stop listening
+     * api.off('connected', handler);
+     * ```
+     */
+    off(type: ApiInterfaceEvents, handler: (...args: any[]) => any): this;
+    /**
+     * @description Attach an one-time eventemitter handler to listen to a specific event
+     *
+     * @param type The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
+     * @param handler The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.once('connected', (): void => {
+     *   console.log('API has been connected to the endpoint');
+     * });
+     *
+     * api.once('disconnected', (): void => {
+     *   console.log('API has been disconnected from the endpoint');
+     * });
+     * ```
+     */
+    once(type: ApiInterfaceEvents, handler: (...args: any[]) => any): this;
+}

package/cjs/base/Events.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Events = void 0;
+const eventemitter3_1 = require("eventemitter3");
+class Events {
+    #eventemitter = new eventemitter3_1.EventEmitter();
+    emit(type, ...args) {
+        return this.#eventemitter.emit(type, ...args);
+    }
+    /**
+     * @description Attach an eventemitter handler to listen to a specific event
+     *
+     * @param type The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
+     * @param handler The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.on('connected', (): void => {
+     *   console.log('API has been connected to the endpoint');
+     * });
+     *
+     * api.on('disconnected', (): void => {
+     *   console.log('API has been disconnected from the endpoint');
+     * });
+     * ```
+     */
+    on(type, handler) {
+        this.#eventemitter.on(type, handler);
+        return this;
+    }
+    /**
+     * @description Remove the given eventemitter handler
+     *
+     * @param type The type of event the callback was attached to. Available events are `connected`, `disconnected`, `ready` and `error`
+     * @param handler The callback to unregister.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * const handler = (): void => {
+     *  console.log('Connected !);
+     * };
+     *
+     * // Start listening
+     * api.on('connected', handler);
+     *
+     * // Stop listening
+     * api.off('connected', handler);
+     * ```
+     */
+    off(type, handler) {
+        this.#eventemitter.removeListener(type, handler);
+        return this;
+    }
+    /**
+     * @description Attach an one-time eventemitter handler to listen to a specific event
+     *
+     * @param type The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
+     * @param handler The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.once('connected', (): void => {
+     *   console.log('API has been connected to the endpoint');
+     * });
+     *
+     * api.once('disconnected', (): void => {
+     *   console.log('API has been disconnected from the endpoint');
+     * });
+     * ```
+     */
+    once(type, handler) {
+        this.#eventemitter.once(type, handler);
+        return this;
+    }
+}
+exports.Events = Events;

package/cjs/base/Getters.d.ts

@@ -0,0 +1,163 @@
+import type { RpcCoreStats, RpcInterface } from '@pezkuwi/rpc-core/types';
+import type { Text } from '@pezkuwi/types';
+import type { Hash, RuntimeVersion } from '@pezkuwi/types/interfaces';
+import type { Metadata } from '@pezkuwi/types/metadata';
+import type { CallFunction, RegistryError } from '@pezkuwi/types/types';
+import type { ApiDecoration, ApiInterfaceRx, ApiTypes, DecoratedErrors, DecoratedEvents, DecoratedRpc, QueryableCalls, QueryableConsts, QueryableStorage, QueryableStorageMulti, SubmittableExtrinsics } from '../types/index.js';
+import { Init } from './Init.js';
+export declare abstract class Getters<ApiType extends ApiTypes> extends Init<ApiType> implements ApiDecoration<ApiType> {
+    /**
+     * @description Runtime call interfaces (currently untyped, only decorated via API options)
+     */
+    get call(): QueryableCalls<ApiType>;
+    /**
+     * @description Contains the parameter types (constants) of all modules.
+     *
+     * The values are instances of the appropriate type and are accessible using `section`.`constantName`,
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * console.log(api.consts.democracy.enactmentPeriod.toString())
+     * ```
+     */
+    get consts(): QueryableConsts<ApiType>;
+    /**
+     * @description Derived results that are injected into the API, allowing for combinations of various query results.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.derive.chain.bestNumber((number) => {
+     *   console.log('best number', number);
+     * });
+     * ```
+     */
+    get derive(): ReturnType<Getters<ApiType>['_decorateDerive']>;
+    /**
+     * @description Errors from metadata
+     */
+    get errors(): DecoratedErrors<ApiType>;
+    /**
+     * @description Events from metadata
+     */
+    get events(): DecoratedEvents<ApiType>;
+    /**
+     * @description  Returns the version of extrinsics in-use on this chain
+     */
+    get extrinsicVersion(): number;
+    /**
+     * @description Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
+     */
+    get genesisHash(): Hash;
+    /**
+     * @description true is the underlying provider is connected
+     */
+    get isConnected(): boolean;
+    /**
+     * @description The library information name & version (from package.json)
+     */
+    get libraryInfo(): string;
+    /**
+     * @description Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
+     *
+     * All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.query.timestamp.now()` (current block timestamp) does not take parameters, while `api.query.system.account(<accountId>)` (retrieving the associated nonce & balances for an account), takes the `AccountId` as a parameter.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.query.system.account(<accountId>, ([nonce, balance]) => {
+     *   console.log('new free balance', balance.free, 'new nonce', nonce);
+     * });
+     * ```
+     */
+    get query(): QueryableStorage<ApiType>;
+    /**
+     * @description Allows for the querying of multiple storage entries and the combination thereof into a single result. This is a very optimal way to make multiple queries since it only makes a single connection to the node and retrieves the data over one subscription.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * const unsub = await api.queryMulti(
+     *   [
+     *     // you can include the storage without any parameters
+     *     api.query.balances.totalIssuance,
+     *     // or you can pass parameters to the storage query
+     *     [api.query.system.account, '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY']
+     *   ],
+     *   ([existential, [, { free }]]) => {
+     *     console.log(`You have ${free.sub(existential)} more than the existential deposit`);
+     *
+     *     unsub();
+     *   }
+     * );
+     * ```
+     */
+    get queryMulti(): QueryableStorageMulti<ApiType>;
+    /**
+     * @description Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
+     *
+     * RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (using known keys) and the submission of transactions.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.rpc.chain.subscribeNewHeads((header) => {
+     *   console.log('new header', header);
+     * });
+     * ```
+     */
+    get rpc(): DecoratedRpc<ApiType, RpcInterface>;
+    /**
+     * @description Contains the chain information for the current node.
+     */
+    get runtimeChain(): Text;
+    /**
+     * @description Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
+     */
+    get runtimeMetadata(): Metadata;
+    /**
+     * @description Contains the version information for the current runtime.
+     */
+    get runtimeVersion(): RuntimeVersion;
+    /**
+     * @description The underlying Rx API interface
+     */
+    get rx(): Pick<ApiInterfaceRx, 'tx' | 'rpc' | 'query' | 'call'>;
+    /**
+     * @description Returns the underlying provider stats
+     */
+    get stats(): RpcCoreStats | undefined;
+    /**
+     * @description The type of this API instance, either 'rxjs' or 'promise'
+     */
+    get type(): ApiTypes;
+    /**
+     * @description Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.tx.balances
+     *   .transferAllowDeath(<recipientId>, <balance>)
+     *   .signAndSend(<keyPair>, ({status}) => {
+     *     console.log('tx status', status.asFinalized.toHex());
+     *   });
+     * ```
+     */
+    get tx(): SubmittableExtrinsics<ApiType>;
+    /**
+     * @description Finds the definition for a specific [[CallFunction]] based on the index supplied
+     */
+    findCall(callIndex: Uint8Array | string): CallFunction;
+    /**
+     * @description Finds the definition for a specific [[RegistryError]] based on the index supplied
+     */
+    findError(errorIndex: Uint8Array | string): RegistryError;
+}

package/cjs/base/Getters.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Getters = void 0;
+const packageInfo_js_1 = require("../packageInfo.js");
+const find_js_1 = require("./find.js");
+const Init_js_1 = require("./Init.js");
+function assertResult(value) {
+    if (value === undefined) {
+        throw new Error("Api interfaces needs to be initialized before using, wait for 'isReady'");
+    }
+    return value;
+}
+class Getters extends Init_js_1.Init {
+    /**
+     * @description Runtime call interfaces (currently untyped, only decorated via API options)
+     */
+    get call() {
+        return assertResult(this._call);
+    }
+    /**
+     * @description Contains the parameter types (constants) of all modules.
+     *
+     * The values are instances of the appropriate type and are accessible using `section`.`constantName`,
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * console.log(api.consts.democracy.enactmentPeriod.toString())
+     * ```
+     */
+    get consts() {
+        return assertResult(this._consts);
+    }
+    /**
+     * @description Derived results that are injected into the API, allowing for combinations of various query results.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.derive.chain.bestNumber((number) => {
+     *   console.log('best number', number);
+     * });
+     * ```
+     */
+    get derive() {
+        return assertResult(this._derive);
+    }
+    /**
+     * @description Errors from metadata
+     */
+    get errors() {
+        return assertResult(this._errors);
+    }
+    /**
+     * @description Events from metadata
+     */
+    get events() {
+        return assertResult(this._events);
+    }
+    /**
+     * @description  Returns the version of extrinsics in-use on this chain
+     */
+    get extrinsicVersion() {
+        return this._extrinsicType;
+    }
+    /**
+     * @description Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.
+     */
+    get genesisHash() {
+        return assertResult(this._genesisHash);
+    }
+    /**
+     * @description true is the underlying provider is connected
+     */
+    get isConnected() {
+        return this._isConnected.getValue();
+    }
+    /**
+     * @description The library information name & version (from package.json)
+     */
+    get libraryInfo() {
+        return `${packageInfo_js_1.packageInfo.name} v${packageInfo_js_1.packageInfo.version}`;
+    }
+    /**
+     * @description Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.
+     *
+     * All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.query.timestamp.now()` (current block timestamp) does not take parameters, while `api.query.system.account(<accountId>)` (retrieving the associated nonce & balances for an account), takes the `AccountId` as a parameter.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.query.system.account(<accountId>, ([nonce, balance]) => {
+     *   console.log('new free balance', balance.free, 'new nonce', nonce);
+     * });
+     * ```
+     */
+    get query() {
+        return assertResult(this._query);
+    }
+    /**
+     * @description Allows for the querying of multiple storage entries and the combination thereof into a single result. This is a very optimal way to make multiple queries since it only makes a single connection to the node and retrieves the data over one subscription.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * const unsub = await api.queryMulti(
+     *   [
+     *     // you can include the storage without any parameters
+     *     api.query.balances.totalIssuance,
+     *     // or you can pass parameters to the storage query
+     *     [api.query.system.account, '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY']
+     *   ],
+     *   ([existential, [, { free }]]) => {
+     *     console.log(`You have ${free.sub(existential)} more than the existential deposit`);
+     *
+     *     unsub();
+     *   }
+     * );
+     * ```
+     */
+    get queryMulti() {
+        return assertResult(this._queryMulti);
+    }
+    /**
+     * @description Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.
+     *
+     * RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (using known keys) and the submission of transactions.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.rpc.chain.subscribeNewHeads((header) => {
+     *   console.log('new header', header);
+     * });
+     * ```
+     */
+    get rpc() {
+        return assertResult(this._rpc);
+    }
+    /**
+     * @description Contains the chain information for the current node.
+     */
+    get runtimeChain() {
+        return assertResult(this._runtimeChain);
+    }
+    /**
+     * @description Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.
+     */
+    get runtimeMetadata() {
+        return assertResult(this._runtimeMetadata);
+    }
+    /**
+     * @description Contains the version information for the current runtime.
+     */
+    get runtimeVersion() {
+        return assertResult(this._runtimeVersion);
+    }
+    /**
+     * @description The underlying Rx API interface
+     */
+    get rx() {
+        return assertResult(this._rx);
+    }
+    /**
+     * @description Returns the underlying provider stats
+     */
+    get stats() {
+        return this._rpcCore.stats;
+    }
+    /**
+     * @description The type of this API instance, either 'rxjs' or 'promise'
+     */
+    get type() {
+        return this._type;
+    }
+    /**
+     * @description Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.
+     *
+     * @example
+     * <BR>
+     *
+     * ```javascript
+     * api.tx.balances
+     *   .transferAllowDeath(<recipientId>, <balance>)
+     *   .signAndSend(<keyPair>, ({status}) => {
+     *     console.log('tx status', status.asFinalized.toHex());
+     *   });
+     * ```
+     */
+    get tx() {
+        return assertResult(this._extrinsics);
+    }
+    /**
+     * @description Finds the definition for a specific [[CallFunction]] based on the index supplied
+     */
+    findCall(callIndex) {
+        return (0, find_js_1.findCall)(this.registry, callIndex);
+    }
+    /**
+     * @description Finds the definition for a specific [[RegistryError]] based on the index supplied
+     */
+    findError(errorIndex) {
+        return (0, find_js_1.findError)(this.registry, errorIndex);
+    }
+}
+exports.Getters = Getters;

package/cjs/base/Init.d.ts

@@ -0,0 +1,44 @@
+import type { RuntimeVersion } from '@pezkuwi/types/interfaces';
+import type { ApiDecoration, ApiOptions, ApiTypes, DecorateMethod } from '../types/index.js';
+import type { VersionedRegistry } from './types.js';
+import { Decorate } from './Decorate.js';
+export declare abstract class Init<ApiType extends ApiTypes> extends Decorate<ApiType> {
+    #private;
+    constructor(options: ApiOptions, type: ApiTypes, decorateMethod: DecorateMethod<ApiType>);
+    /**
+     * @description Decorates a registry based on the runtime version
+     */
+    private _initRegistry;
+    /**
+     * @description Returns the default versioned registry
+     */
+    private _getDefaultRegistry;
+    /**
+     * @description Returns a decorated API instance at a specific point in time
+     */
+    at(blockHash: Uint8Array | string, knownVersion?: RuntimeVersion): Promise<ApiDecoration<ApiType>>;
+    private _createBlockRegistry;
+    private _cacheBlockRegistryProgress;
+    private _getBlockRegistryViaVersion;
+    private _getBlockRegistryViaHash;
+    /**
+     * @description Sets up a registry based on the block hash defined
+     */
+    getBlockRegistry(blockHash: Uint8Array, knownVersion?: RuntimeVersion): Promise<VersionedRegistry<ApiType>>;
+    protected _loadMeta(): Promise<boolean>;
+    private _metaFromSource;
+    private _subscribeUpdates;
+    private _metaFromChain;
+    private _initFromMeta;
+    /**
+     * @internal
+     *
+     * Tries to use runtime api calls to retrieve metadata. This ensures the api initializes with the latest metadata.
+     * If the runtime call is not there it will use the rpc method.
+     */
+    private _retrieveMetadata;
+    private _subscribeHealth;
+    private _unsubscribeHealth;
+    private _unsubscribeUpdates;
+    protected _unsubscribe(): void;
+}