@dedot/api 0.0.1-alpha.39 → 0.0.1-alpha.40

package/chaintypes/substrate/tx.d.ts

@@ -1,7 +1,7 @@
 import type { AccountId32Like, BytesLike, Data, Extrinsic, FixedBytes, FixedU128, FixedU64, H256, MultiAddressLike, Perbill, Percent, Perquintill } from '@dedot/codecs';
-import type { GenericChainTx, GenericTxCall, IRuntimeTxCall, ISubmittableExtrinsic, ISubmittableExtrinsicLegacy, ISubmittableResult, RpcV2, RpcVersion, TransactionStatusLegacy, TransactionStatusV2 } from '@dedot/types';
+import type { GenericChainTx, GenericTxCall, IRuntimeTxCall, ISubmittableExtrinsic, ISubmittableExtrinsicLegacy, ISubmittableResult, RpcV2, RpcVersion, TransactionEvent } from '@dedot/types';
 import type { FrameSupportPreimagesBounded, FrameSupportScheduleDispatchTime, FrameSupportTokensFungibleUnionOfNativeOrWithId, FrameSystemEventRecord, KitchensinkRuntimeOriginCaller, KitchensinkRuntimeProxyType, KitchensinkRuntimeRuntimeCallLike, KitchensinkRuntimeRuntimeParameters, KitchensinkRuntimeSessionKeys, PalletAllianceCid, PalletAllianceDisbandWitness, PalletAllianceUnscrupulousItem, PalletBalancesAdjustmentDirection, PalletBrokerConfigRecord, PalletBrokerCoreMask, PalletBrokerFinality, PalletBrokerRegionId, PalletBrokerScheduleItem, PalletContractsWasmDeterminism, PalletConvictionVotingConviction, PalletConvictionVotingVoteAccountVote, PalletCoreFellowshipParamsType, PalletCoreFellowshipWish, PalletDemocracyConviction, PalletDemocracyMetadataOwner, PalletDemocracyVoteAccountVote, PalletElectionProviderMultiPhaseRawSolution, PalletElectionProviderMultiPhaseSolutionOrSnapshotSize, PalletElectionsPhragmenRenouncing, PalletIdentityJudgement, PalletIdentityLegacyIdentityInfo, PalletImOnlineHeartbeat, PalletImOnlineSr25519AppSr25519Signature, PalletMigrationsHistoricCleanupSelector, PalletMigrationsMigrationCursor, PalletMixnetRegistration, PalletMultisigTimepoint, PalletNftsAttributeNamespace, PalletNftsBitFlags, PalletNftsCancelAttributesApprovalWitness, PalletNftsCollectionConfig, PalletNftsDestroyWitness, PalletNftsItemConfig, PalletNftsItemTip, PalletNftsMintSettings, PalletNftsMintWitness, PalletNftsPreSignedAttributes, PalletNftsPreSignedMint, PalletNftsPriceWithDirection, PalletNominationPoolsBondExtra, PalletNominationPoolsClaimPermission, PalletNominationPoolsCommissionChangeRate, PalletNominationPoolsCommissionClaimPermission, PalletNominationPoolsConfigOp, PalletNominationPoolsConfigOp004, PalletNominationPoolsConfigOpPerbill, PalletNominationPoolsConfigOpU32, PalletNominationPoolsPoolState, PalletStakingPalletConfigOp, PalletStakingPalletConfigOpPerbill, PalletStakingPalletConfigOpPercent, PalletStakingPalletConfigOpU32, PalletStakingRewardDestination, PalletStakingValidatorPrefs, PalletStateTrieMigrationMigrationLimits, PalletStateTrieMigrationMigrationTask, PalletStateTrieMigrationProgress, PalletUniquesDestroyWitness, PalletVestingVestingInfo, SpConsensusBabeDigestsNextConfigDescriptor, SpConsensusBeefyEquivocationProof, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpMixnetAppSignature, SpNposElectionsElectionScore, SpNposElectionsSupport, SpRuntimeMultiSignature, SpSessionMembershipProof, SpTransactionStorageProofTransactionStorageProof, SpWeightsWeightV2Weight } from './types.js';
-export type ChainSubmittableExtrinsic<Rv extends RpcVersion, T extends IRuntimeTxCall = KitchensinkRuntimeRuntimeCallLike> = Extrinsic<MultiAddressLike, T, SpRuntimeMultiSignature, any[]> & (Rv extends RpcV2 ? ISubmittableExtrinsic<ISubmittableResult<FrameSystemEventRecord, TransactionStatusV2>> : ISubmittableExtrinsicLegacy<ISubmittableResult<FrameSystemEventRecord, TransactionStatusLegacy>>);
+export type ChainSubmittableExtrinsic<Rv extends RpcVersion, T extends IRuntimeTxCall = KitchensinkRuntimeRuntimeCallLike> = Extrinsic<MultiAddressLike, T, SpRuntimeMultiSignature, any[]> & (Rv extends RpcV2 ? ISubmittableExtrinsic<ISubmittableResult<FrameSystemEventRecord, TransactionEvent>> : ISubmittableExtrinsicLegacy<ISubmittableResult<FrameSystemEventRecord, TransactionEvent>>);
 export type TxCall<Rv extends RpcVersion> = (...args: any[]) => ChainSubmittableExtrinsic<Rv>;
 export interface ChainTx<Rv extends RpcVersion> extends GenericChainTx<Rv, TxCall<Rv>> {
     /**

package/cjs/extrinsic/submittable/SubmittableExtrinsic.js

@@ -4,6 +4,7 @@ exports.SubmittableExtrinsic = void 0;
 const utils_1 = require("@dedot/utils");
 const BaseSubmittableExtrinsic_js_1 = require("./BaseSubmittableExtrinsic.js");
 const SubmittableResult_js_1 = require("./SubmittableResult.js");
+const utils_js_1 = require("./utils.js");
 /**
  * @name SubmittableExtrinsic
  * @description A wrapper around an Extrinsic that exposes methods to sign, send, and other utility around Extrinsic.
@@ -22,9 +23,9 @@ class SubmittableExtrinsic extends BaseSubmittableExtrinsic_js_1.BaseSubmittable
         const txHex = this.toHex();
         const txHash = this.hash;
         if (isSubscription) {
-            return this.api.rpc.author_submitAndWatchExtrinsic(txHex, async (status) => {
-                if (status.type === 'InBlock' || status.type === 'Finalized') {
-                    const blockHash = status.value;
+            return this.api.rpc.author_submitAndWatchExtrinsic(txHex, async (txStatus) => {
+                if (txStatus.type === 'InBlock' || txStatus.type === 'Finalized') {
+                    const blockHash = txStatus.value;
                     const [signedBlock, blockEvents] = await Promise.all([
                         this.api.rpc.chain_getBlock(blockHash),
                         this.getSystemEventsAt(blockHash),
@@ -32,9 +33,11 @@ class SubmittableExtrinsic extends BaseSubmittableExtrinsic_js_1.BaseSubmittable
                     const txIndex = signedBlock.block.extrinsics.indexOf(txHex);
                     (0, utils_1.assert)(txIndex >= 0, 'Extrinsic not found!');
                     const events = blockEvents.filter(({ phase }) => phase.type === 'ApplyExtrinsic' && phase.value === txIndex);
+                    const status = (0, utils_js_1.toTransactionEvent)(txStatus, txIndex);
                     return callback(new SubmittableResult_js_1.SubmittableResult({ status, txHash, events, txIndex }));
                 }
                 else {
+                    const status = (0, utils_js_1.toTransactionEvent)(txStatus);
                     return callback(new SubmittableResult_js_1.SubmittableResult({ status, txHash }));
                 }
             });

package/cjs/extrinsic/submittable/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.signRaw = exports.isKeyringPair = void 0;
+exports.toTransactionEvent = exports.signRaw = exports.isKeyringPair = void 0;
 const utils_1 = require("@dedot/utils");
 function isKeyringPair(account) {
     return (0, utils_1.isFunction)(account.sign);
@@ -18,3 +18,68 @@ function signRaw(signerPair, raw) {
     return signerPair.sign(toSignRaw, { withType: true });
 }
 exports.signRaw = signRaw;
+/**
+ * Convert transaction status to transaction event
+ *
+ * Ref: https://github.com/paritytech/polkadot-sdk/blob/98a364fe6e7abf10819f5fddd3de0588f7c38700/substrate/client/rpc-spec-v2/src/transaction/transaction.rs#L132-L159
+ * @param txStatus
+ * @param txIndex
+ */
+function toTransactionEvent(txStatus, txIndex) {
+    switch (txStatus.type) {
+        case 'Ready':
+        case 'Future':
+            return { type: 'Validated' };
+        case 'Broadcast':
+            return { type: 'Broadcasting' };
+        case 'Retracted':
+            return { type: 'NoLongerInBestChain' };
+        case 'InBlock':
+            (0, utils_1.assert)(txIndex, 'TxIndex is required');
+            return {
+                type: 'BestChainBlockIncluded',
+                value: {
+                    blockHash: txStatus.value,
+                    txIndex,
+                },
+            };
+        case 'Finalized':
+            (0, utils_1.assert)(txIndex, 'TxIndex is required');
+            return {
+                type: 'Finalized',
+                value: {
+                    blockHash: txStatus.value,
+                    txIndex,
+                },
+            };
+        case 'FinalityTimeout':
+            return {
+                type: 'Drop',
+                value: {
+                    error: 'Maximum number of finality watchers has been reached',
+                },
+            };
+        case 'Dropped':
+            return {
+                type: 'Drop',
+                value: {
+                    error: 'Extrinsic dropped from the pool due to exceeding limits',
+                },
+            };
+        case 'Usurped':
+            return {
+                type: 'Invalid',
+                value: {
+                    error: 'Extrinsic was rendered invalid by another extrinsic',
+                },
+            };
+        case 'Invalid':
+            return {
+                type: 'Invalid',
+                value: {
+                    error: 'Extrinsic marked as invalid',
+                },
+            };
+    }
+}
+exports.toTransactionEvent = toTransactionEvent;

package/extrinsic/submittable/SubmittableExtrinsic.js

@@ -1,6 +1,7 @@
 import { assert, isHex } from '@dedot/utils';
 import { BaseSubmittableExtrinsic } from './BaseSubmittableExtrinsic.js';
 import { SubmittableResult } from './SubmittableResult.js';
+import { toTransactionEvent } from './utils.js';
 /**
  * @name SubmittableExtrinsic
  * @description A wrapper around an Extrinsic that exposes methods to sign, send, and other utility around Extrinsic.
@@ -19,9 +20,9 @@ export class SubmittableExtrinsic extends BaseSubmittableExtrinsic {
         const txHex = this.toHex();
         const txHash = this.hash;
         if (isSubscription) {
-            return this.api.rpc.author_submitAndWatchExtrinsic(txHex, async (status) => {
-                if (status.type === 'InBlock' || status.type === 'Finalized') {
-                    const blockHash = status.value;
+            return this.api.rpc.author_submitAndWatchExtrinsic(txHex, async (txStatus) => {
+                if (txStatus.type === 'InBlock' || txStatus.type === 'Finalized') {
+                    const blockHash = txStatus.value;
                     const [signedBlock, blockEvents] = await Promise.all([
                         this.api.rpc.chain_getBlock(blockHash),
                         this.getSystemEventsAt(blockHash),
@@ -29,9 +30,11 @@ export class SubmittableExtrinsic extends BaseSubmittableExtrinsic {
                     const txIndex = signedBlock.block.extrinsics.indexOf(txHex);
                     assert(txIndex >= 0, 'Extrinsic not found!');
                     const events = blockEvents.filter(({ phase }) => phase.type === 'ApplyExtrinsic' && phase.value === txIndex);
+                    const status = toTransactionEvent(txStatus, txIndex);
                     return callback(new SubmittableResult({ status, txHash, events, txIndex }));
                 }
                 else {
+                    const status = toTransactionEvent(txStatus);
                     return callback(new SubmittableResult({ status, txHash }));
                 }
             });

package/extrinsic/submittable/utils.d.ts

@@ -1,5 +1,6 @@
 import { IKeyringPair } from '@polkadot/types/types';
-import type { AddressOrPair } from '@dedot/types';
+import { TransactionStatus } from '@dedot/codecs';
+import type { AddressOrPair, TransactionEvent } from '@dedot/types';
 import { HexString } from '@dedot/utils';
 export declare function isKeyringPair(account: AddressOrPair): account is IKeyringPair;
 /**
@@ -8,3 +9,11 @@ export declare function isKeyringPair(account: AddressOrPair): account is IKeyri
  * @param raw
  */
 export declare function signRaw(signerPair: IKeyringPair, raw: HexString): Uint8Array;
+/**
+ * Convert transaction status to transaction event
+ *
+ * Ref: https://github.com/paritytech/polkadot-sdk/blob/98a364fe6e7abf10819f5fddd3de0588f7c38700/substrate/client/rpc-spec-v2/src/transaction/transaction.rs#L132-L159
+ * @param txStatus
+ * @param txIndex
+ */
+export declare function toTransactionEvent(txStatus: TransactionStatus, txIndex?: number): TransactionEvent;

package/extrinsic/submittable/utils.js

@@ -1,4 +1,4 @@
-import { blake2AsU8a, hexToU8a, isFunction } from '@dedot/utils';
+import { assert, blake2AsU8a, hexToU8a, isFunction } from '@dedot/utils';
 export function isKeyringPair(account) {
     return isFunction(account.sign);
 }
@@ -13,3 +13,67 @@ export function signRaw(signerPair, raw) {
     const toSignRaw = u8a.length > 256 ? blake2AsU8a(u8a, 256) : u8a;
     return signerPair.sign(toSignRaw, { withType: true });
 }
+/**
+ * Convert transaction status to transaction event
+ *
+ * Ref: https://github.com/paritytech/polkadot-sdk/blob/98a364fe6e7abf10819f5fddd3de0588f7c38700/substrate/client/rpc-spec-v2/src/transaction/transaction.rs#L132-L159
+ * @param txStatus
+ * @param txIndex
+ */
+export function toTransactionEvent(txStatus, txIndex) {
+    switch (txStatus.type) {
+        case 'Ready':
+        case 'Future':
+            return { type: 'Validated' };
+        case 'Broadcast':
+            return { type: 'Broadcasting' };
+        case 'Retracted':
+            return { type: 'NoLongerInBestChain' };
+        case 'InBlock':
+            assert(txIndex, 'TxIndex is required');
+            return {
+                type: 'BestChainBlockIncluded',
+                value: {
+                    blockHash: txStatus.value,
+                    txIndex,
+                },
+            };
+        case 'Finalized':
+            assert(txIndex, 'TxIndex is required');
+            return {
+                type: 'Finalized',
+                value: {
+                    blockHash: txStatus.value,
+                    txIndex,
+                },
+            };
+        case 'FinalityTimeout':
+            return {
+                type: 'Drop',
+                value: {
+                    error: 'Maximum number of finality watchers has been reached',
+                },
+            };
+        case 'Dropped':
+            return {
+                type: 'Drop',
+                value: {
+                    error: 'Extrinsic dropped from the pool due to exceeding limits',
+                },
+            };
+        case 'Usurped':
+            return {
+                type: 'Invalid',
+                value: {
+                    error: 'Extrinsic was rendered invalid by another extrinsic',
+                },
+            };
+        case 'Invalid':
+            return {
+                type: 'Invalid',
+                value: {
+                    error: 'Extrinsic marked as invalid',
+                },
+            };
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/api",
-  "version": "0.0.1-alpha.39",
+  "version": "0.0.1-alpha.40",
   "description": "A delightful JavaScript/TypeScript client for Polkadot & Substrate",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/api",
@@ -13,13 +13,13 @@
   "type": "module",
   "sideEffects": false,
   "dependencies": {
-    "@dedot/codecs": "0.0.1-alpha.39",
-    "@dedot/providers": "0.0.1-alpha.39",
-    "@dedot/runtime-specs": "0.0.1-alpha.39",
-    "@dedot/shape": "0.0.1-alpha.39",
-    "@dedot/storage": "0.0.1-alpha.39",
-    "@dedot/types": "0.0.1-alpha.39",
-    "@dedot/utils": "0.0.1-alpha.39"
+    "@dedot/codecs": "0.0.1-alpha.40",
+    "@dedot/providers": "0.0.1-alpha.40",
+    "@dedot/runtime-specs": "0.0.1-alpha.40",
+    "@dedot/shape": "0.0.1-alpha.40",
+    "@dedot/storage": "0.0.1-alpha.40",
+    "@dedot/types": "0.0.1-alpha.40",
+    "@dedot/utils": "0.0.1-alpha.40"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json",
@@ -48,7 +48,7 @@
   "devDependencies": {
     "@polkadot/types": "^12.1.1"
   },
-  "gitHead": "1dc9046a8bbd7dfc38f4f4c4a9fbd4033eca181d",
+  "gitHead": "c6c3d9d748851f01ce79c13541754809be6628fc",
   "module": "./index.js",
   "types": "./index.d.ts"
 }