polkadot-api 1.1.0 → 1.2.1

package/dist/index.d.ts

@@ -319,9 +319,15 @@ type TxEventsPayload = {
     };
 } & ({
     ok: true;
+    /**
+     * Dispatch Error found at `System.ExtrinsicFailed` event.
+     */
     dispatchError?: undefined;
 } | {
     ok: false;
+    /**
+     * Dispatch Error found at `System.ExtrinsicFailed` event.
+     */
     dispatchError: {
         type: string;
         value: unknown;
@@ -331,6 +337,9 @@ type TxFinalized = {
     type: "finalized";
     txHash: HexString;
 } & TxEventsPayload;
+type TxFinalizedPayload = {
+    txHash: HexString;
+} & TxEventsPayload;
 type TxOptions<Asset> = Partial<void extends Asset ? {
     /**
      * Block to target the transaction against. Default: `"finalized"`
@@ -383,7 +392,6 @@ type TxOptions<Asset> = Partial<void extends Asset ? {
      */
     nonce: number;
 }>;
-type TxFinalizedPayload = Omit<TxFinalized, "type">;
 type TxPromise<Asset> = (from: PolkadotSigner, txOptions?: TxOptions<Asset>) => Promise<TxFinalizedPayload>;
 type TxObservable<Asset> = (from: PolkadotSigner, txOptions?: TxOptions<Asset>) => Observable<TxEvent>;
 interface TxCall {
@@ -468,6 +476,26 @@ interface TxEntry<D, Arg extends {} | undefined, Pallet extends string, Name ext
      */
     (...args: Arg extends undefined ? [] : [data: Arg]): Transaction<Arg, Pallet, Name, Asset>;
 }
+interface TxFromBinary<Asset> {
+    /**
+     * Asynchronously create the transaction object from a binary call data ready
+     * to sign, submit, estimate fees, etc.
+     *
+     * @param callData  SCALE-encoded call data.
+     * @returns Transaction object.
+     */
+    (callData: Binary): Promise<Transaction<any, any, any, Asset>>;
+    /**
+     * Synchronously create the transaction object from a binary call data ready
+     * to sign, submit, estimate fees, etc.
+     *
+     * @param callData            SCALE-encoded call data.
+     * @param compatibilityToken  Token from got with `await
+     *                            typedApi.compatibilityToken`
+     * @returns Transaction object.
+     */
+    (callData: Binary, compatibilityToken: CompatibilityToken): Transaction<any, any, any, Asset>;
+}
 
 declare class InvalidTxError extends Error {
     error: any;
@@ -510,6 +538,7 @@ type ConstApi<D, A extends Record<string, Record<string, any>>> = {
 type TypedApi<D extends ChainDefinition> = {
     query: StorageApi<D, QueryFromPalletsDef<D["descriptors"]["pallets"]>>;
     tx: TxApi<D, TxFromPalletsDef<D["descriptors"]["pallets"]>, D["asset"]["_type"]>;
+    txFromCallData: TxFromBinary<D["asset"]["_type"]>;
     event: EvApi<D, EventsFromPalletsDef<D["descriptors"]["pallets"]>>;
     apis: RuntimeCallsApi<D, D["descriptors"]["apis"]>;
     constants: ConstApi<D, ConstFromPalletsDef<D["descriptors"]["pallets"]>>;
@@ -630,6 +659,13 @@ interface PolkadotClient {
 type FixedSizeArray<L extends number, T> = Array<T> & {
     length: L;
 };
+type TxCallData = {
+    type: string;
+    value: {
+        type: string;
+        value: any;
+    };
+};
 
 /**
  * This is the top-level export for `polkadot-api`.
@@ -654,4 +690,4 @@ type FixedSizeArray<L extends number, T> = Array<T> & {
  */
 declare function createClient(provider: JsonRpcProvider): PolkadotClient;
 
-export { type ApisTypedef, type ChainDefinition, type ConstFromPalletsDef, type DescriptorEntry, type ErrorsFromPalletsDef, type EventPhase, type EventsFromPalletsDef, type FixedSizeArray, InvalidTxError, type PalletsTypedef, type PlainDescriptor, type PolkadotClient, type QueryFromPalletsDef, type RuntimeDescriptor, type StorageDescriptor, type Transaction, type TransactionValidityError, type TxBestBlocksState, type TxBroadcastEvent, type TxBroadcasted, type TxCall, type TxDescriptor, type TxEntry, type TxEvent, type TxEventsPayload, type TxFinalized, type TxFinalizedPayload, type TxFromPalletsDef, type TxInBestBlocksFound, type TxInBestBlocksNotFound, type TxObservable, type TxOptions, type TxPromise, type TxSignFn, type TxSigned, type TypedApi, createClient };
+export { type ApisTypedef, type ChainDefinition, type ConstFromPalletsDef, type DescriptorEntry, type ErrorsFromPalletsDef, type EventPhase, type EventsFromPalletsDef, type FixedSizeArray, InvalidTxError, type PalletsTypedef, type PlainDescriptor, type PolkadotClient, type QueryFromPalletsDef, type RuntimeDescriptor, type StorageDescriptor, type Transaction, type TransactionValidityError, type TxBestBlocksState, type TxBroadcastEvent, type TxBroadcasted, type TxCall, type TxCallData, type TxDescriptor, type TxEntry, type TxEvent, type TxEventsPayload, type TxFinalized, type TxFinalizedPayload, type TxFromPalletsDef, type TxInBestBlocksFound, type TxInBestBlocksNotFound, type TxObservable, type TxOptions, type TxPromise, type TxSignFn, type TxSigned, type TypedApi, createClient };

package/dist/index.js

@@ -22,7 +22,6 @@ var OpType = /* @__PURE__ */ ((OpType2) => {
   OpType2["Storage"] = "storage";
   OpType2["Tx"] = "tx";
   OpType2["Event"] = "events";
-  OpType2["Error"] = "errors";
   OpType2["Const"] = "constants";
   return OpType2;
 })(OpType || {});
@@ -162,6 +161,8 @@ const createConstantEntry = (palletName, name, {
       (p) => p.name === palletName
     );
     const constant = pallet?.constants.find((c) => c.name === name);
+    if (constant == null)
+      throw new Error(`Runtime entry Constant(${palletName}.${name}) not found`);
     const result = ctx.dynamicBuilder.buildConstant(palletName, name).dec(constant.value);
     cachedResults.set(ctx, result);
     return result;
@@ -377,6 +378,13 @@ const createEventEntry = (pallet, name, chainHead, {
   const shared$ = chainHead.finalized$.pipe(
     withCompatibleRuntime(chainHead, (x) => x.hash),
     rxjs.map(([block, runtime, ctx]) => {
+      const eventsIdx = ctx.lookup.metadata.pallets.find(
+        (p) => p.name === pallet
+      )?.events;
+      if (eventsIdx == null || ctx.lookup.metadata.lookup[eventsIdx].def.tag !== "variant" || ctx.lookup.metadata.lookup[eventsIdx].def.value.find(
+        (ev) => ev.name === name
+      ) == null)
+        throw new Error(`Runtime entry Event(${pallet}.${name}) not found`);
       if (!argsAreCompatible(runtime, ctx, null)) throw compatibilityError();
       return [block, runtime, ctx];
     }),
@@ -424,8 +432,13 @@ const createRuntimeCallEntry = (api, method, chainHead, {
     const at = _at ?? null;
     const result$ = compatibleRuntime$(chainHead, at).pipe(
       rxjs.mergeMap(([runtime, ctx]) => {
+        let codecs;
+        try {
+          codecs = ctx.dynamicBuilder.buildRuntimeCall(api, method);
+        } catch {
+          throw new Error(`Runtime entry RuntimeCall(${callName}) not found`);
+        }
         if (!argsAreCompatible(runtime, ctx, args)) throw compatibilityError();
-        const codecs = ctx.dynamicBuilder.buildRuntimeCall(api, method);
         return chainHead.call$(at, callName, utils.toHex(codecs.args.enc(args))).pipe(
           rxjs.map(codecs.value.dec),
           rxjs.map((value) => {
@@ -453,6 +466,13 @@ const createStorageEntry = (pallet, name, chainHead, {
   const isSystemNumber = pallet === "System" && name === "Number";
   const incompatibleError = () => new Error(`Incompatible runtime entry Storage(${pallet}.${name})`);
   const invalidArgs = (args) => new Error(`Invalid Arguments calling ${pallet}.${name}(${args})`);
+  const getCodec = (ctx) => {
+    try {
+      return ctx.dynamicBuilder.buildStorage(pallet, name);
+    } catch {
+      throw new Error(`Runtime entry Storage(${pallet}.${name}) not found`);
+    }
+  };
   const watchValue = (...args) => {
     const target = args[args.length - 1];
     const actualArgs = target === "best" || target === "finalized" ? args.slice(0, -1) : args;
@@ -465,9 +485,9 @@ const createStorageEntry = (pallet, name, chainHead, {
       rxjs.debounceTime(0),
       withCompatibleRuntime(chainHead, (x) => x.hash),
       raceMap(([block, runtime, ctx]) => {
+        const codecs = getCodec(ctx);
         if (!argsAreCompatible(runtime, ctx, actualArgs))
           throw incompatibleError();
-        const codecs = ctx.dynamicBuilder.buildStorage(pallet, name);
         return chainHead.storage$(block.hash, "value", () => codecs.enc(...actualArgs)).pipe(
           rxjs.map((val) => {
             if (!valuesAreCompatible(runtime, ctx, val))
@@ -507,7 +527,7 @@ const createStorageEntry = (pallet, name, chainHead, {
         at,
         "value",
         (ctx) => {
-          const codecs = ctx.dynamicBuilder.buildStorage(pallet, name);
+          const codecs = getCodec(ctx);
           const actualArgs = args.length === codecs.len ? args : args.slice(0, -1);
           if (args !== actualArgs && !isLastArgOptional) throw invalidArgs(args);
           if (!argsAreCompatible(descriptors, ctx, actualArgs))
@@ -516,7 +536,7 @@ const createStorageEntry = (pallet, name, chainHead, {
         },
         null,
         (data, ctx) => {
-          const codecs = ctx.dynamicBuilder.buildStorage(pallet, name);
+          const codecs = getCodec(ctx);
           const value = data === null ? codecs.fallback : codecs.dec(data);
           if (!valuesAreCompatible(descriptors, ctx, value))
             throw incompatibleError();
@@ -536,9 +556,9 @@ const createStorageEntry = (pallet, name, chainHead, {
       at,
       "descendantsValues",
       (ctx) => {
+        const codecs = getCodec(ctx);
         if (minCompatLevel(getCompatibilityLevels(descriptors, ctx)) === metadataCompatibility.CompatibilityLevel.Incompatible)
           throw incompatibleError();
-        const codecs = ctx.dynamicBuilder.buildStorage(pallet, name);
         if (args.length > codecs.len) throw invalidArgs(args);
         const actualArgs = args.length > 0 && isLastArgOptional ? args.slice(0, -1) : args;
         if (args.length === codecs.len && actualArgs === args)
@@ -547,7 +567,7 @@ const createStorageEntry = (pallet, name, chainHead, {
       },
       null,
       (values, ctx) => {
-        const codecs = ctx.dynamicBuilder.buildStorage(pallet, name);
+        const codecs = getCodec(ctx);
         if (values.some(
           ({ value }) => !valuesAreCompatible(descriptors, ctx, value)
         ))
@@ -925,13 +945,19 @@ const createTxEntry = (pallet, name, chainHead, broadcast, {
   compatibleRuntime$,
   argsAreCompatible,
   getRuntimeTypedef
-}) => {
+}, checkCompatibility) => {
   const fn = (arg) => {
     const getCallDataWithContext = (runtime, arg2, txOptions = {}) => {
       const ctx = getCompatibilityApi(runtime).runtime();
-      if (!argsAreCompatible(runtime, ctx, arg2))
-        throw new Error(`Incompatible runtime entry Tx(${pallet}.${name})`);
       const { dynamicBuilder, assetId, lookup } = ctx;
+      let codecs;
+      try {
+        codecs = dynamicBuilder.buildCall(pallet, name);
+      } catch {
+        throw new Error(`Runtime entry Tx(${pallet}.${name}) not found`);
+      }
+      if (checkCompatibility && !argsAreCompatible(runtime, ctx, arg2))
+        throw new Error(`Incompatible runtime entry Tx(${pallet}.${name})`);
       let returnOptions = txOptions;
       if (txOptions.asset) {
         if (assetId == null || !metadataCompatibility.isCompatible(
@@ -945,7 +971,7 @@ const createTxEntry = (pallet, name, chainHead, broadcast, {
           asset: dynamicBuilder.buildDefinition(assetId).enc(txOptions.asset)
         };
       }
-      const { location, codec } = dynamicBuilder.buildCall(pallet, name);
+      const { location, codec } = codecs;
       return {
         callData: substrateBindings.Binary.fromBytes(
           utils.mergeUint8(new Uint8Array(location), codec.enc(arg2))
@@ -1072,7 +1098,8 @@ const createTypedApi = (compatibilityToken, chainHead, broadcast$) => {
         compatibilityToken,
         (r) => r.getPalletEntryPoint(OpType.Tx, pallet, name),
         (ctx) => getEnumEntry(ctx, "args", getPallet(ctx, pallet).calls, name)
-      )
+      ),
+      true
     )
   );
   const event = createProxyPath(
@@ -1114,8 +1141,32 @@ const createTypedApi = (compatibilityToken, chainHead, broadcast$) => {
       )
     )
   );
+  const _callDataTx = (callData, token) => {
+    const { lookup, dynamicBuilder } = getCompatibilityApi(token).runtime();
+    try {
+      const decoded = dynamicBuilder.buildDefinition(lookup.call).dec(callData.asBytes());
+      const pallet = decoded.type;
+      const call = decoded.value.type;
+      const args = decoded.value.value;
+      return createTxEntry(
+        pallet,
+        call,
+        chainHead,
+        broadcast$,
+        compatibilityHelper(
+          compatibilityToken,
+          (r) => r.getPalletEntryPoint(OpType.Tx, pallet, call),
+          (ctx) => getEnumEntry(ctx, "args", getPallet(ctx, pallet).calls, call)
+        ),
+        false
+      )(args);
+    } catch {
+      throw new Error("createTx: invalid call data");
+    }
+  };
   return {
     query,
+    txFromCallData: (callData, token) => token ? _callDataTx(callData, token) : compatibilityToken.then((t) => _callDataTx(callData, t)),
     tx,
     event,
     apis,