dedot 0.0.1-next.f5bf4fc2.1 → 0.1.0

package/index.d.ts

@@ -1,6 +1,3 @@
-import { Dedot } from './client';
-export type * from './types';
-export * from './executor';
-export * from './extrinsic';
-export { Dedot };
-export { WsProvider } from '@polkadot/rpc-provider';
+export * as $ from '@dedot/shape';
+export * from '@dedot/api';
+export * from '@dedot/providers';

package/index.js

@@ -1,5 +1,3 @@
-import { Dedot } from './client';
-export * from './executor';
-export * from './extrinsic';
-export { Dedot };
-export { WsProvider } from '@polkadot/rpc-provider';
+export * as $ from '@dedot/shape';
+export * from '@dedot/api';
+export * from '@dedot/providers';

package/package.json

@@ -1,54 +1,98 @@
 {
   "name": "dedot",
-  "version": "0.0.1-next.f5bf4fc2.1+f5bf4fc",
+  "version": "0.1.0",
   "description": "A delightful JavaScript/TypeScript client for Polkadot & Substrate",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot",
   "repository": {
-    "directory": "packages/api",
+    "directory": "packages/dedot",
     "type": "git",
     "url": "https://github.com/dedotdev/dedot.git"
   },
   "main": "./cjs/index.js",
-  "type": "module",
+  "bin": {
+    "dedot": "./bin/dedot",
+    "djs": "./bin/dedot"
+  },
   "sideEffects": false,
+  "type": "module",
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && cp -R ./bin ./dist",
+    "clean": "rm -rf ./dist && rm -rf ./tsconfig.tsbuildinfo ./tsconfig.build.tsbuildinfo"
+  },
   "dependencies": {
-    "@dedot/chaintypes": "0.0.1-next.f5bf4fc2.1+f5bf4fc",
-    "@dedot/codecs": "0.0.1-next.f5bf4fc2.1+f5bf4fc",
-    "@dedot/shape": "0.0.1-next.f5bf4fc2.1+f5bf4fc",
-    "@dedot/specs": "0.0.1-next.f5bf4fc2.1+f5bf4fc",
-    "@dedot/storage": "0.0.1-next.f5bf4fc2.1+f5bf4fc",
-    "@dedot/utils": "0.0.1-next.f5bf4fc2.1+f5bf4fc",
-    "@polkadot/rpc-provider": "^10.11.2",
-    "@polkadot/util": "^12.6.2"
+    "@dedot/api": "0.1.0",
+    "@dedot/cli": "0.1.0",
+    "@dedot/codecs": "0.1.0",
+    "@dedot/contracts": "0.1.0",
+    "@dedot/providers": "0.1.0",
+    "@dedot/runtime-specs": "0.1.0",
+    "@dedot/shape": "0.1.0",
+    "@dedot/types": "0.1.0",
+    "@dedot/utils": "0.1.0"
   },
-  "scripts": {
-    "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json",
-    "clean": "rm -rf ./dist && rm -rf ./tsconfig.tsbuildinfo ./tsconfig.build.tsbuildinfo",
-    "test": "vitest --watch=false"
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./cjs/index.js",
+      "default": "./index.js"
+    },
+    "./chaintypes": {
+      "types": "./chaintypes/index.d.ts",
+      "import": "./chaintypes/index.js",
+      "require": "./cjs/chaintypes/index.js",
+      "default": "./chaintypes/index.js"
+    },
+    "./codecs": {
+      "types": "./codecs/index.d.ts",
+      "import": "./codecs/index.js",
+      "require": "./cjs/codecs/index.js",
+      "default": "./codecs/index.js"
+    },
+    "./types": {
+      "types": "./types/index.d.ts",
+      "import": "./types/index.js",
+      "require": "./cjs/types/index.js",
+      "default": "./types/index.js"
+    },
+    "./types/json-rpc": {
+      "types": "./types/json-rpc/index.d.ts",
+      "import": "./types/json-rpc/index.js",
+      "require": "./cjs/types/json-rpc/index.js",
+      "default": "./types/json-rpc/index.js"
+    },
+    "./runtime-specs": {
+      "types": "./runtime-specs/index.d.ts",
+      "import": "./runtime-specs/index.js",
+      "require": "./cjs/runtime-specs/index.js",
+      "default": "./runtime-specs/index.js"
+    },
+    "./utils": {
+      "types": "./utils/index.d.ts",
+      "import": "./utils/index.js",
+      "require": "./cjs/utils/index.js",
+      "default": "./utils/index.js"
+    },
+    "./shape": {
+      "types": "./shape/index.d.ts",
+      "import": "./shape/index.js",
+      "require": "./cjs/shape/index.js",
+      "default": "./shape/index.js"
+    },
+    "./contracts": {
+      "types": "./contracts/index.d.ts",
+      "import": "./contracts/index.js",
+      "require": "./cjs/contracts/index.js",
+      "default": "./contracts/index.js"
+    }
   },
   "publishConfig": {
     "access": "public",
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "devDependencies": {
-    "@polkadot/keyring": "^12.6.2",
-    "@polkadot/types": "^10.11.2"
-  },
-  "gitHead": "f5bf4fc22dadbbac59819df38cd0c9dccddc8dfd",
+  "gitHead": "c8220a4ab4b171fe04adb49759318bde865d7c17",
   "module": "./index.js",
-  "types": "./index.d.ts",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./index.d.ts",
-        "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./cjs/index.js"
-      }
-    }
-  }
+  "types": "./index.d.ts"
 }

package/runtime-specs/index.d.ts

@@ -0,0 +1 @@
+export * from '@dedot/runtime-specs';

package/runtime-specs/index.js

@@ -0,0 +1 @@
+export * from '@dedot/runtime-specs';

package/shape/index.d.ts

@@ -0,0 +1 @@
+export * from '@dedot/shape';

package/shape/index.js

@@ -0,0 +1 @@
+export * from '@dedot/shape';

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from '@dedot/types';

package/types/index.js

@@ -0,0 +1 @@
+export * from '@dedot/types';

package/types/json-rpc/index.d.ts

@@ -0,0 +1 @@
+export * from '@dedot/types/json-rpc';

package/types/json-rpc/index.js

@@ -0,0 +1 @@
+export * from '@dedot/types/json-rpc';

package/utils/index.d.ts

@@ -0,0 +1 @@
+export * from '@dedot/utils';

package/utils/index.js

@@ -0,0 +1 @@
+export * from '@dedot/utils';

package/cjs/client/Dedot.js

@@ -1,436 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Dedot = exports.SUPPORTED_METADATA_VERSIONS = exports.CATCH_ALL_METADATA_KEY = exports.KEEP_ALIVE_INTERVAL = void 0;
-const rpc_provider_1 = require("@polkadot/rpc-provider");
-const codecs_1 = require("@dedot/codecs");
-const executor_1 = require("../executor");
-const proxychain_1 = require("../proxychain");
-const util_1 = require("@polkadot/util");
-const storage_1 = require("@dedot/storage");
-const utils_1 = require("@dedot/utils");
-exports.KEEP_ALIVE_INTERVAL = 10_000; // in ms
-exports.CATCH_ALL_METADATA_KEY = `RAW_META/ALL`;
-exports.SUPPORTED_METADATA_VERSIONS = [15, 14];
-/**
- * @name Dedot
- * @description Promised-based API Client for Polkadot & Substrate
- *
- * ### Initialize API instance and interact with substrate-based network
- * ```typescript
- * import { Dedot } from 'dedot';
- * import { PolkadotApi } from '@dedot/chaintypes/polkadot';
- *
- * const run = async () => {
- *   const api = await Dedot.new<PolkadotApi>('wss://rpc.polkadot.io');
- *
- *   // Call rpc `state_getMetadata` to fetch raw scale-encoded metadata and decode it.
- *   const metadata = await api.rpc.state.getMetadata();
- *   console.log('Metadata:', metadata);
- *
- *   // Query on-chain storage
- *   const address = '14...';
- *   const balance = await api.query.system.account(address);
- *   console.log('Balance:', balance);
- *
- *
- *   // Subscribe to on-chain storage changes
- *   const unsub = await api.query.system.number((blockNumber) => {
- *     console.log(`Current block number: ${blockNumber}`);
- *   });
- *
- *   // Get pallet constants
- *   const ss58Prefix = api.consts.system.ss58Prefix;
- *   console.log('Polkadot ss58Prefix:', ss58Prefix)
- *
- *   // await unsub();
- *   // await api.disconnect();
- * }
- *
- * run().catch(console.error);
- * ```
- */
-class Dedot {
-    #provider;
-    #options;
-    #registry;
-    #metadata;
-    #metadataLatest;
-    #genesisHash;
-    #runtimeVersion;
-    #chainProperties;
-    #runtimeChain;
-    #localCache;
-    #runtimeSubscriptionUnsub;
-    #healthTimer;
-    /**
-     * Use factory methods (`create`, `new`) to create `Dedot` instances.
-     *
-     * @param options
-     * @protected
-     */
-    constructor(options) {
-        this.#options = this.#normalizeOptions(options);
-        this.#provider = this.#getProvider();
-    }
-    /**
-     * Factory method to create a new Dedot instance
-     *
-     * @param options
-     */
-    static async create(options) {
-        const api = new Dedot(options);
-        if (api.provider instanceof rpc_provider_1.WsProvider) {
-            await api.provider.isReady;
-        }
-        await api.init();
-        return api;
-    }
-    /**
-     * Alias for __Dedot.create__
-     * @param options
-     */
-    static async new(options) {
-        return Dedot.create(options);
-    }
-    /**
-     * Initialize APIs before usage
-     */
-    async init() {
-        await this.#initializeLocalCache();
-        // Fetching node information
-        let [genesisHash, runtimeVersion, chainName, chainProps, metadata] = await Promise.all([
-            this.rpc.chain.getBlockHash(0),
-            this.rpc.state.getRuntimeVersion(),
-            this.rpc.system.chain(),
-            this.rpc.system.properties(),
-            (await this.#shouldLoadPreloadMetadata()) ? this.#fetchMetadata() : Promise.resolve(undefined),
-        ]);
-        this.#genesisHash = genesisHash;
-        this.#runtimeVersion = runtimeVersion;
-        this.#chainProperties = chainProps;
-        this.#runtimeChain = chainName;
-        await this.#setupMetadata(metadata);
-        this.#subscribeUpdates();
-    }
-    async #initializeLocalCache() {
-        if (!this.#options.cacheMetadata)
-            return;
-        // Initialize local cache
-        if (this.#options.cacheStorage) {
-            this.#localCache = this.#options.cacheStorage;
-            return;
-        }
-        try {
-            this.#localCache = new storage_1.LocalStorage();
-        }
-        catch {
-            throw new Error('localStorage is not available for caching, please provide a cacheStorage option');
-        }
-    }
-    async #setupMetadata(preloadMetadata) {
-        let metadata = preloadMetadata;
-        const metadataKey = this.currentMetadataKey;
-        const optMetadataBundles = this.#options.metadata;
-        let shouldUpdateCache = !!metadata;
-        if (optMetadataBundles && !metadata) {
-            const optRawMetadata = optMetadataBundles[exports.CATCH_ALL_METADATA_KEY] || optMetadataBundles[metadataKey];
-            if (optRawMetadata) {
-                metadata = codecs_1.$Metadata.tryDecode(optRawMetadata);
-            }
-        }
-        try {
-            if (this.#localCache && this.#options.cacheMetadata) {
-                if (!metadata) {
-                    try {
-                        const cachedRawMetadata = await this.#localCache.get(metadataKey);
-                        if (cachedRawMetadata) {
-                            metadata = codecs_1.$Metadata.tryDecode(cachedRawMetadata);
-                        }
-                    }
-                    catch (e) {
-                        console.error('Cannot decode raw metadata, try fetching fresh metadata from chain.', e);
-                    }
-                }
-            }
-        }
-        finally {
-            if (!metadata) {
-                metadata = await this.#fetchMetadata();
-                if (this.#options.cacheMetadata)
-                    shouldUpdateCache = true;
-            }
-        }
-        if (shouldUpdateCache && this.#localCache) {
-            await this.#localCache.set(metadataKey, (0, util_1.u8aToHex)(codecs_1.$Metadata.tryEncode(metadata)));
-        }
-        if (!metadata) {
-            throw new Error('Cannot load metadata');
-        }
-        this.setMetadata(metadata);
-    }
-    async #fetchMetadata() {
-        // It makes sense to call metadata.metadataVersions to fetch the list of supported metadata versions first
-        // But for now, this approach could potentially help save/reduce one rpc call to the server in case the node support v15
-        // Question: Why not having a `metadata.metadataLatest` to fetch the latest version?
-        for (const version of exports.SUPPORTED_METADATA_VERSIONS) {
-            try {
-                const rawMetadata = await this.call.metadata.metadataAtVersion(version);
-                if (!rawMetadata)
-                    continue;
-                return codecs_1.$Metadata.tryDecode(rawMetadata);
-            }
-            catch { }
-        }
-        try {
-            return codecs_1.$Metadata.tryDecode(await this.call.metadata.metadata());
-        }
-        catch {
-            return await this.rpc.state.getMetadata();
-        }
-    }
-    #subscribeRuntimeUpgrades() {
-        // Disable runtime upgrades subscriptions if using a catch all metadata
-        if (this.#runtimeSubscriptionUnsub || !this.hasSubscriptions || this.hasCatchAllMetadata) {
-            return;
-        }
-        this.rpc.state
-            .subscribeRuntimeVersion(async (runtimeVersion) => {
-            if (runtimeVersion.specVersion !== this.#runtimeVersion?.specVersion) {
-                this.#runtimeVersion = runtimeVersion;
-                const newMetadata = await this.#fetchMetadata();
-                await this.#setupMetadata(newMetadata);
-            }
-        })
-            .then((unsub) => {
-            this.#runtimeSubscriptionUnsub = unsub;
-        });
-    }
-    #subscribeHealth() {
-        this.#unsubscribeHealth();
-        this.#healthTimer = setInterval(() => {
-            this.rpc.system.health().catch(console.error);
-        }, exports.KEEP_ALIVE_INTERVAL);
-    }
-    #unsubscribeHealth() {
-        if (!this.#healthTimer) {
-            return;
-        }
-        clearInterval(this.#healthTimer);
-        this.#healthTimer = undefined;
-    }
-    async #unsubscribeRuntimeUpdates() {
-        if (!this.#runtimeSubscriptionUnsub) {
-            return;
-        }
-        await this.#runtimeSubscriptionUnsub();
-        this.#runtimeSubscriptionUnsub = undefined;
-    }
-    #subscribeUpdates() {
-        this.#subscribeRuntimeUpgrades();
-        this.#subscribeHealth();
-    }
-    async #unsubscribeUpdates() {
-        await this.#unsubscribeRuntimeUpdates();
-        this.#unsubscribeHealth();
-    }
-    async #shouldLoadPreloadMetadata() {
-        if (this.#options.metadata && Object.keys(this.#options.metadata).length) {
-            return false;
-        }
-        if (!this.#options.cacheMetadata || !this.#localCache) {
-            return true;
-        }
-        // TODO improve this
-        const keys = await this.#localCache.keys();
-        return !keys.some((k) => k.startsWith('RAW_META/'));
-    }
-    #normalizeOptions(options) {
-        if (typeof options === 'string') {
-            return { endpoint: options };
-        }
-        else {
-            let { metadata } = options || {};
-            if (metadata && typeof metadata === 'string') {
-                metadata = {
-                    [exports.CATCH_ALL_METADATA_KEY]: (0, util_1.hexAddPrefix)(metadata),
-                };
-            }
-            return { ...options, metadata };
-        }
-    }
-    #getProvider() {
-        const { provider, endpoint } = this.#options;
-        if (provider) {
-            (0, utils_1.assert)(provider.hasSubscriptions, 'Only supports RPC Provider can make subscription requests');
-            return provider;
-        }
-        if (endpoint) {
-            if (endpoint.startsWith('ws://') || endpoint.startsWith('wss://')) {
-                return new rpc_provider_1.WsProvider(endpoint);
-            }
-            else {
-                throw new Error('Invalid RPC network endpoint, a valid endpoint should start with `wss://`, `ws://`');
-            }
-        }
-        // TODO support light-client
-        return new rpc_provider_1.WsProvider();
-    }
-    /**
-     * @description Entry-point for executing RPCs to blockchain node.
-     *
-     * ```typescript
-     * // Subscribe to new heads
-     * api.rpc.chain.subscribeNewHeads((header) => {
-     *   console.log(header);
-     * });
-     *
-     * // Execute arbitrary rpc method: `module_rpc_name`
-     * const result = await api.rpc.module.rpc_name();
-     * ```
-     */
-    get rpc() {
-        // TODO add executable carrier to support calling arbitrary rpc methods via api.rpc(<method>)
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.RpcExecutor(this) });
-    }
-    /**
-     * @description Entry-point for inspecting constants (parameter types) for all pallets (modules).
-     *
-     * ```typescript
-     * const ss58Prefix = api.consts.system.ss58Prefix;
-     * console.log('ss58Prefix:', ss58Prefix)
-     * ```
-     */
-    get consts() {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.ConstantExecutor(this) });
-    }
-    /**
-     * @description Entry-point for executing query to on-chain storage.
-     *
-     * ```typescript
-     * const balance = await api.query.system.account(<address>);
-     * console.log('Balance:', balance);
-     * ```
-     */
-    get query() {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.StorageQueryExecutor(this) });
-    }
-    queryAt(blockHash) {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.StorageQueryExecutor(this, blockHash) });
-    }
-    /**
-     * @description Entry-point for inspecting errors from metadata
-     */
-    get errors() {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.ErrorExecutor(this) });
-    }
-    /**
-     * @description Entry-point for inspecting events from metadata
-     */
-    get events() {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.EventExecutor(this) });
-    }
-    get call() {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.RuntimeApiExecutor(this) });
-    }
-    callAt(blockHash) {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.RuntimeApiExecutor(this, blockHash) });
-    }
-    get tx() {
-        return (0, proxychain_1.newProxyChain)({ executor: new executor_1.TxExecutor(this) });
-    }
-    /**
-     * @description Current provider for api connection
-     */
-    get provider() {
-        return this.#provider;
-    }
-    /**
-     * @description Codec registry
-     */
-    get registry() {
-        return this.#registry;
-    }
-    /**
-     * @description Check if metadata is present
-     */
-    get hasMetadata() {
-        return !!this.#metadata && !!this.#metadataLatest;
-    }
-    get metadata() {
-        return this.#metadata;
-    }
-    get metadataLatest() {
-        return this.#metadataLatest;
-    }
-    /**
-     * Setup metadata for
-     * @param metadata
-     */
-    setMetadata(metadata) {
-        this.#metadata = metadata;
-        this.#metadataLatest = metadata.latest;
-        this.#registry = new codecs_1.PortableRegistry(this.#metadataLatest);
-    }
-    /**
-     * @description Disconnect to blockchain node
-     */
-    async disconnect() {
-        await this.#unsubscribeUpdates();
-        await this.#provider.disconnect();
-    }
-    /**
-     * @description Clear local cache
-     */
-    async clearCache() {
-        await this.#localCache?.clear();
-    }
-    /**
-     * @description Check if current provider can make subscription request (e.: via WebSocket)
-     */
-    get hasSubscriptions() {
-        return this.provider.hasSubscriptions;
-    }
-    /**
-     * @description Check if it's connected to the blockchain node
-     */
-    get isConnected() {
-        return this.provider.isConnected;
-    }
-    /**
-     * @description Check if the api instance is using a catch-all metadata
-     */
-    get hasCatchAllMetadata() {
-        return !!this.#options.metadata && !!this.#options.metadata[exports.CATCH_ALL_METADATA_KEY];
-    }
-    get currentMetadataKey() {
-        return `RAW_META/${this.#genesisHash || '0x'}/${this.#runtimeVersion?.specVersion || '---'}`;
-    }
-    /**
-     * @description Genesis hash of connected blockchain node
-     */
-    get genesisHash() {
-        return this.#genesisHash;
-    }
-    /**
-     * @description Runtime version of connected blockchain node
-     */
-    get runtimeVersion() {
-        return this.#runtimeVersion;
-    }
-    /**
-     * @description Chain properties of connected blockchain node
-     */
-    get chainProperties() {
-        return this.#chainProperties;
-    }
-    /**
-     * @description Runtime chain name of connected blockchain node
-     */
-    get runtimeChain() {
-        return this.#runtimeChain;
-    }
-    get options() {
-        return this.#options;
-    }
-}
-exports.Dedot = Dedot;

package/cjs/executor/ConstantExecutor.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConstantExecutor = void 0;
-const util_1 = require("@polkadot/util");
-const Executor_1 = require("./Executor");
-/**
- * @name ConstantExecutor
- *
- * Find & decode the constant value from metadata
- */
-class ConstantExecutor extends Executor_1.Executor {
-    execute(pallet, constantName) {
-        const targetPallet = this.getPallet(pallet);
-        const constantDef = targetPallet.constants.find((one) => (0, util_1.stringCamelCase)(one.name) === constantName);
-        if (!constantDef) {
-            throw new Error(`Constant ${constantName} not found in pallet ${pallet}`);
-        }
-        const $codec = this.registry.findCodec(constantDef.typeId);
-        return $codec.tryDecode(constantDef.value);
-    }
-}
-exports.ConstantExecutor = ConstantExecutor;