@polymeshassociation/polymesh-sdk 15.0.0-alpha.16 → 15.0.0-alpha.17

package/base/PolymeshTransaction.d.ts

@@ -3,17 +3,23 @@ import { ISubmittableResult } from '@polkadot/types/types';
 import BigNumber from 'bignumber.js';
 import { Context, PolymeshTransactionBase } from "../internal";
 import { TxTag } from "../types";
-import { MapMaybePostTransactionValue, TransactionSpec } from "../types/internal";
+import { TransactionSigningData, TransactionSpec } from "../types/internal";
 /**
  * Wrapper class for a Polymesh Transaction
  */
-export declare class PolymeshTransaction<Args extends unknown[] | [] = unknown[], Values extends unknown[] = unknown[]> extends PolymeshTransactionBase<Values> {
+export declare class PolymeshTransaction<ReturnValue, TransformedReturnValue = ReturnValue, Args extends unknown[] | [] = unknown[]> extends PolymeshTransactionBase<ReturnValue, TransformedReturnValue> {
     /**
      * @hidden
-     *
-     * unwrapped arguments (available right before execution)
      */
-    private unwrappedArgs?;
+    static toTransactionSpec<R, T, A extends unknown[] | [] = unknown[]>(inputTransaction: PolymeshTransaction<R, T, A>): TransactionSpec<R, A, T>;
+    /**
+     * arguments for the transaction in SCALE format (polkadot.js Codec)
+     */
+    args: Args;
+    /**
+     * type of transaction represented by this instance (mostly for display purposes)
+     */
+    tag: TxTag;
     /**
      * @hidden
      *
@@ -28,26 +34,21 @@ export declare class PolymeshTransaction<Args extends unknown[] | [] = unknown[]
      *
      * @note defaults to 1
      */
-    protected feeMultiplier: BigNumber;
-    /**
-     * arguments for the transaction. Available after the transaction starts running
-     * (may be Post Transaction Values from a previous transaction in the queue that haven't resolved yet)
-     */
-    inputArgs: MapMaybePostTransactionValue<Args>;
-    /**
-     * type of transaction represented by this instance (mostly for display purposes)
-     */
-    tag: TxTag;
+    protected feeMultiplier?: BigNumber;
     /**
      * @hidden
+     *
+     * used by procedures to set the protocol fee manually in case the protocol op can't be
+     *   dynamically generated from the transaction name, or a specific procedure has
+     *   special rules for calculating them
      */
-    constructor(transactionSpec: TransactionSpec<Args, Values>, context: Context);
+    private protocolFee?;
     /**
-     * arguments for the transaction
+     * @hidden
      */
-    get args(): Args;
+    constructor(transactionSpec: TransactionSpec<ReturnValue, Args, TransformedReturnValue> & TransactionSigningData, context: Context);
     protected composeTx(): SubmittableExtrinsic<'promise', ISubmittableResult>;
-    protected getProtocolFees(): Promise<BigNumber>;
+    getProtocolFees(): Promise<BigNumber>;
     protected ignoresSubsidy(): boolean;
     supportsSubsidy(): boolean;
 }

package/base/PolymeshTransaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PolymeshTransaction.d.ts","sourceRoot":"","sources":["../../src/base/PolymeshTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,oBAAmB;AAC9D,OAAO,EAAE,KAAK,EAAU,iBAAgB;AACxC,OAAO,EAAE,4BAA4B,EAAc,eAAe,EAAE,0BAAyB;AAI7F;;GAEG;AACH,qBAAa,mBAAmB,CAC9B,IAAI,SAAS,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,EACvC,MAAM,SAAS,OAAO,EAAE,GAAG,OAAO,EAAE,CACpC,SAAQ,uBAAuB,CAAC,MAAM,CAAC;IACvC;;;;OAIG;IACH,OAAO,CAAC,aAAa,CAAC,CAAO;IAE7B;;;;OAIG;IACH,OAAO,CAAC,WAAW,CAAmB;IAEtC;;;;;;;OAOG;IACH,SAAS,CAAC,aAAa,YAAC;IAExB;;;OAGG;IACI,SAAS,EAAE,4BAA4B,CAAC,IAAI,CAAC,CAAC;IAErD;;OAEG;IACI,GAAG,EAAE,KAAK,CAAC;IAElB;;OAEG;gBACS,eAAe,EAAE,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO;IAW5E;;OAEG;IACH,IAAW,IAAI,IAAI,IAAI,CAMtB;IAGD,SAAS,CAAC,SAAS,IAAI,oBAAoB,CAAC,SAAS,EAAE,kBAAkB,CAAC;cAO1D,eAAe,IAAI,OAAO,CAAC,SAAS,CAAC;cAQlC,cAAc,IAAI,OAAO;IASrC,eAAe,IAAI,OAAO;CAKlC"}
+{"version":3,"file":"PolymeshTransaction.d.ts","sourceRoot":"","sources":["../../src/base/PolymeshTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,oBAAmB;AAC9D,OAAO,EAAE,KAAK,EAAU,iBAAgB;AACxC,OAAO,EAAc,sBAAsB,EAAE,eAAe,EAAE,0BAAyB;AAGvF;;GAEG;AACH,qBAAa,mBAAmB,CAC9B,WAAW,EACX,sBAAsB,GAAG,WAAW,EACpC,IAAI,SAAS,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,CACvC,SAAQ,uBAAuB,CAAC,WAAW,EAAE,sBAAsB,CAAC;IACpE;;OAEG;WACoB,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,EACjF,gBAAgB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAC7C,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAa3B;;OAEG;IACI,IAAI,EAAE,IAAI,CAAC;IAElB;;OAEG;IACI,GAAG,EAAE,KAAK,CAAC;IAElB;;;;OAIG;IACH,OAAO,CAAC,WAAW,CAAmB;IAEtC;;;;;;;OAOG;IACH,SAAS,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,WAAW,CAAC,CAAY;IAEhC;;OAEG;gBAED,eAAe,EAAE,eAAe,CAAC,WAAW,EAAE,IAAI,EAAE,sBAAsB,CAAC,GACzE,sBAAsB,EACxB,OAAO,EAAE,OAAO;IAelB,SAAS,CAAC,SAAS,IAAI,oBAAoB,CAAC,SAAS,EAAE,kBAAkB,CAAC;IAO7D,eAAe,IAAI,OAAO,CAAC,SAAS,CAAC;cAc/B,cAAc,IAAI,OAAO;IASrC,eAAe,IAAI,OAAO;CAKlC"}

package/base/PolymeshTransaction.js

@@ -28,7 +28,6 @@ const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const internal_1 = require("../internal");
 const types_1 = require("../types");
 const conversion_1 = require("../utils/conversion");
-const internal_2 = require("../utils/internal");
 /**
  * Wrapper class for a Polymesh Transaction
  */
@@ -37,21 +36,25 @@ class PolymeshTransaction extends internal_1.PolymeshTransactionBase {
      * @hidden
      */
     constructor(transactionSpec, context) {
-        const { args = [], feeMultiplier = new bignumber_js_1.default(1), transaction } = transactionSpec, rest = __rest(transactionSpec, ["args", "feeMultiplier", "transaction"]);
+        const { args = [], feeMultiplier, transaction, fee, paidForBy } = transactionSpec, rest = __rest(transactionSpec, ["args", "feeMultiplier", "transaction", "fee", "paidForBy"]);
         super(rest, context);
-        this.inputArgs = args;
+        this.args = args;
         this.transaction = transaction;
         this.tag = (0, conversion_1.transactionToTxTag)(transaction);
         this.feeMultiplier = feeMultiplier;
+        this.protocolFee = fee;
+        this.paidForBy = paidForBy;
     }
     /**
-     * arguments for the transaction
+     * @hidden
      */
-    get args() {
-        if (!this.unwrappedArgs) {
-            this.unwrappedArgs = (0, internal_2.unwrapValues)(this.inputArgs);
-        }
-        return this.unwrappedArgs;
+    static toTransactionSpec(inputTransaction) {
+        const spec = internal_1.PolymeshTransactionBase.toTransactionSpec(inputTransaction);
+        const { transaction, args, protocolFee: fee, feeMultiplier } = inputTransaction;
+        return Object.assign(Object.assign({}, spec), { transaction,
+            args,
+            fee,
+            feeMultiplier });
     }
     // eslint-disable-next-line require-jsdoc
     composeTx() {
@@ -61,9 +64,13 @@ class PolymeshTransaction extends internal_1.PolymeshTransactionBase {
     // eslint-disable-next-line require-jsdoc
     getProtocolFees() {
         return __awaiter(this, void 0, void 0, function* () {
-            const { tag } = this;
-            const [{ fees }] = yield this.context.getProtocolFees({ tags: [tag] });
-            return fees.multipliedBy(this.feeMultiplier);
+            const { protocolFee, feeMultiplier = new bignumber_js_1.default(1) } = this;
+            let fees = protocolFee;
+            if (!fees) {
+                const { tag } = this;
+                [{ fees }] = yield this.context.getProtocolFees({ tags: [tag] });
+            }
+            return fees.multipliedBy(feeMultiplier);
         });
     }
     // eslint-disable-next-line require-jsdoc

package/base/PolymeshTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"PolymeshTransaction.js","sourceRoot":"","sources":["../../src/base/PolymeshTransaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,gEAAqC;AAErC,0CAA8D;AAC9D,oCAAwC;AAExC,oDAAwD;AACxD,gDAAgD;AAEhD;;GAEG;AACH,MAAa,mBAGX,SAAQ,kCAA+B;IAoCvC;;OAEG;IACH,YAAY,eAA8C,EAAE,OAAgB;QAC1E,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,aAAa,GAAG,IAAI,sBAAS,CAAC,CAAC,CAAC,EAAE,WAAW,KAAc,eAAe,EAAxB,IAAI,UAAK,eAAe,EAAvF,wCAAqE,CAAkB,CAAC;QAE9F,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAErB,IAAI,CAAC,SAAS,GAAG,IAAqD,CAAC;QACvE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,IAAA,+BAAkB,EAAC,WAAW,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,IAAI,CAAC,aAAa,GAAG,IAAA,uBAAY,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,yCAAyC;IAC/B,SAAS;QACjB,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEnC,OAAO,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,yCAAyC;IACzB,eAAe;;YAC7B,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;YACrB,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAEvE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,yCAAyC;IACtB,cAAc;QAC/B;;;WAGG;QACH,OAAO,IAAI,CAAC,GAAG,KAAK,cAAM,CAAC,OAAO,CAAC,eAAe,CAAC;IACrD,CAAC;IAED,yCAAyC;IAClC,eAAe;QACpB,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAE9B,OAAO,OAAO,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1C,CAAC;CACF;AA9FD,kDA8FC"}
+{"version":3,"file":"PolymeshTransaction.js","sourceRoot":"","sources":["../../src/base/PolymeshTransaction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,gEAAqC;AAErC,0CAA8D;AAC9D,oCAAwC;AAExC,oDAAwD;AAExD;;GAEG;AACH,MAAa,mBAIX,SAAQ,kCAA4D;IAuDpE;;OAEG;IACH,YACE,eACwB,EACxB,OAAgB;QAEhB,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,EAAE,SAAS,KAAc,eAAe,EAAxB,IAAI,UAAK,eAAe,EAApF,4DAAkE,CAAkB,CAAC;QAE3F,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAErB,IAAI,CAAC,IAAI,GAAG,IAAY,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,GAAG,GAAG,IAAA,+BAAkB,EAAC,WAAW,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAxED;;OAEG;IACI,MAAM,CAAU,iBAAiB,CACtC,gBAA8C;QAE9C,MAAM,IAAI,GAAG,kCAAuB,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;QACzE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,gBAAgB,CAAC;QAEhF,OAAO,gCACF,IAAI,KACP,WAAW;YACX,IAAI;YACJ,GAAG;YACH,aAAa,GACyB,CAAC;IAC3C,CAAC;IA0DD,yCAAyC;IAC/B,SAAS;QACjB,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEnC,OAAO,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,yCAAyC;IAC5B,eAAe;;YAC1B,MAAM,EAAE,WAAW,EAAE,aAAa,GAAG,IAAI,sBAAS,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;YAE/D,IAAI,IAAI,GAAG,WAAW,CAAC;YAEvB,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;gBACrB,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aAClE;YAED,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED,yCAAyC;IACtB,cAAc;QAC/B;;;WAGG;QACH,OAAO,IAAI,CAAC,GAAG,KAAK,cAAM,CAAC,OAAO,CAAC,eAAe,CAAC;IACrD,CAAC;IAED,yCAAyC;IAClC,eAAe;QACpB,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAE9B,OAAO,OAAO,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1C,CAAC;CACF;AAnHD,kDAmHC"}

package/base/PolymeshTransactionBase.d.ts

@@ -1,16 +1,20 @@
 /// <reference types="node" />
 import { SubmittableExtrinsic } from '@polkadot/api/types';
-import { DispatchError } from '@polkadot/types/interfaces';
+import { SpRuntimeDispatchError } from "../polkadot/types-lookup.ts";
 import { ISubmittableResult, Signer as PolkadotSigner } from '@polkadot/types/types';
 import BigNumber from 'bignumber.js';
 import { EventEmitter } from 'events';
 import { Context, Identity, PolymeshError } from "../internal";
-import { Fees, PayingAccount, TransactionStatus } from "../types";
-import { BaseTransactionSpec, PostTransactionValueArray } from "../types/internal";
+import { PayingAccountFees, TransactionStatus, UnsubCallback } from "../types";
+import { BaseTransactionSpec, MaybeResolverFunction, TransactionSigningData } from "../types/internal";
 /**
  * Wrapper class for a Polymesh Transaction
  */
-export declare abstract class PolymeshTransactionBase<Values extends unknown[] = unknown[]> {
+export declare abstract class PolymeshTransactionBase<ReturnValue = void, TransformedReturnValue = ReturnValue> {
+    /**
+     * @hidden
+     */
+    static toTransactionSpec<R, T>(transaction: PolymeshTransactionBase<R, T>): BaseTransactionSpec<R, T>;
     /**
      * current status of the transaction
      */
@@ -39,10 +43,6 @@ export declare abstract class PolymeshTransactionBase<Values extends unknown[] =
      * number of the block where this transaction resides (status: `Succeeded`, `Failed`)
      */
     blockNumber?: BigNumber;
-    /**
-     * whether this transaction failing makes the entire transaction queue fail or not
-     */
-    isCritical: boolean;
     /**
      * @hidden
      *
@@ -53,9 +53,9 @@ export declare abstract class PolymeshTransactionBase<Values extends unknown[] =
     /**
      * @hidden
      *
-     * wrappers for values that will exist after this transaction has executed
+     * function that transforms the transaction's return value before returning it after it is run
      */
-    protected postValues: PostTransactionValueArray<Values>;
+    protected resolver: MaybeResolverFunction<ReturnValue>;
     /**
      * @hidden
      *
@@ -77,20 +77,27 @@ export declare abstract class PolymeshTransactionBase<Values extends unknown[] =
     /**
      * @hidden
      *
-     * used by procedures to set the fee manually in case the protocol op can't be
-     *   dynamically generated from the transaction name, or a specific procedure has
-     *   special rules for calculating them
+     * function that transforms the return value to another type. Useful when using the same
+     *   Procedure for different endpoints which are supposed to return different values
      */
-    protected protocolFee?: BigNumber;
+    protected transformer?: (result: ReturnValue) => Promise<TransformedReturnValue> | TransformedReturnValue;
     protected context: Context;
     /**
      * @hidden
+     * whether the queue has run or not (prevents re-running)
      */
-    constructor(transactionSpec: BaseTransactionSpec<Values>, context: Context);
+    private hasRun;
     /**
-     * Run the transaction and update its status
+     * @hidden
      */
-    run(): Promise<void>;
+    constructor(transactionSpec: BaseTransactionSpec<ReturnValue, TransformedReturnValue> & TransactionSigningData, context: Context);
+    /**
+     * Run the transaction, update its status and return a result if applicable.
+     *   Certain transactions create Entities on the blockchain, and those Entities are returned
+     *   for convenience. For example, when running a transaction that creates an Asset, the Asset itself
+     *   is returned
+     */
+    run(): Promise<TransformedReturnValue>;
     /**
      * @hidden
      *
@@ -105,25 +112,34 @@ export declare abstract class PolymeshTransactionBase<Values extends unknown[] =
      *
      * @returns unsubscribe function
      */
-    onStatusChange(listener: (transaction: this) => void): () => void;
+    onStatusChange(listener: (transaction: PolymeshTransactionBase) => void): UnsubCallback;
     /**
-     * Retrieve the Account that would pay fees for the transaction if it was run at this moment, as well as the total amount that can be
-     *   charged to it (allowance). A null allowance means that there is no limit to that amount
+     * Retrieve a breakdown of the fees required to run this transaction, as well as the Account responsible for paying them
+     *
+     * @note these values might be inaccurate if the transaction is run at a later time. This can be due to a governance vote or other
+     *   chain related factors (like modifications to a specific subsidizer relationship or a chain upgrade)
+     */
+    getTotalFees(): Promise<PayingAccountFees>;
+    /**
+     * Subscribe to the results of this transaction being processed by the indexing service (and as such, available to the middleware)
      *
-     * A null return value signifies that the caller Account would pay the fees
+     * @param listener - callback function that will be called whenever the middleware is updated with the latest data.
+     *   If there is an error (timeout or middleware offline) it will be passed to this callback
      *
-     * @note this value might change if, before running the transaction, the caller Account enters (or leaves)
-     *   a subsidizer relationship
+     * @note this event will be fired even if the queue fails
+     * @returns unsubscribe function
+     * @throws if the middleware wasn't enabled when instantiating the SDK client
      */
-    getPayingAccount(): Promise<PayingAccount | null>;
+    onProcessedByMiddleware(listener: (err?: PolymeshError) => void): UnsubCallback;
     /**
-     * Get all (protocol and gas) fees associated with this transaction. Returns null
-     * if the transaction is not ready yet (this can happen if it depends on the execution of a
-     * previous transaction in the queue)
+     * Poll the middleware every 2 seconds to see if it has already processed the
+     *   block that reflects the changes brought on by this transaction being run. If so,
+     *   emit the corresponding event. After 5 retries (or if the middleware can't be reached),
+     *   the event is emitted with an error
      *
-     * @note this value might change if the transaction is run at a later time. This can be due to a governance vote
+     * @note uses the middleware
      */
-    getFees(): Promise<Fees | null>;
+    private emitWhenMiddlewareIsSynced;
     /**
      * @hidden
      */
@@ -133,7 +149,7 @@ export declare abstract class PolymeshTransactionBase<Values extends unknown[] =
      *   AND the caller is being subsidized by a third party, the transaction can't be executed and trying
      *   to do so will result in an error
      *
-     * @note this depends on the type of transaction itself (i.e. `staking.bond` can't be subsidized, but `asset.createAsset` can)
+     * @note this depends on the type of transaction itself (e.g. `staking.bond` can't be subsidized, but `asset.createAsset` can)
      */
     abstract supportsSubsidy(): boolean;
     /**
@@ -150,18 +166,37 @@ export declare abstract class PolymeshTransactionBase<Values extends unknown[] =
      */
     protected ignoresSubsidy(): boolean;
     /**
-     * @hidden
-     *
-     * Fetch and calculate this transaction's protocol fees
+     * Return this transaction's protocol fees. These are extra fees charged for
+     *   specific operations on the chain. Not to be confused with network fees (which
+     *   depend on the complexity of the operation), protocol fees are set by governance and/or
+     *   chain upgrades
      */
-    protected abstract getProtocolFees(): Promise<BigNumber>;
+    abstract getProtocolFees(): Promise<BigNumber>;
     /**
      * @hidden
      */
-    protected handleExtrinsicFailure(_resolve: (value: ISubmittableResult | PromiseLike<ISubmittableResult>) => void, reject: (reason?: unknown) => void, error: DispatchError, data?: Record<string, unknown>): void;
+    protected handleExtrinsicFailure(_resolve: (value: ISubmittableResult | PromiseLike<ISubmittableResult>) => void, reject: (reason?: unknown) => void, error: SpRuntimeDispatchError, data?: Record<string, unknown>): void;
     /**
      * @hidden
      */
     protected handleExtrinsicSuccess(resolve: (value: ISubmittableResult | PromiseLike<ISubmittableResult>) => void, _reject: (reason?: unknown) => void, receipt: ISubmittableResult): void;
+    /**
+     * @hidden
+     *
+     * Check if balances and allowances (both third party and signing Account)
+     *   are sufficient to cover this transaction's fees
+     */
+    private assertFeesCovered;
+    /**
+     * @hidden
+     *
+     * Retrieve the Account that would pay fees for the transaction if it was run at this moment, as well as the total amount that can be
+     *   charged to it (allowance) in case of a subsidy
+     *
+     * @note the paying Account might change if, before running the transaction, the caller Account enters (or leaves)
+     *   a subsidizer relationship. A governance vote or chain upgrade could also cause the value to change between the time
+     *   this method is called and the time the transaction is run
+     */
+    private getPayingAccount;
 }
 //# sourceMappingURL=PolymeshTransactionBase.d.ts.map

package/base/PolymeshTransactionBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PolymeshTransactionBase.d.ts","sourceRoot":"","sources":["../../src/base/PolymeshTransactionBase.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAe,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAiB,MAAM,IAAI,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACpG,OAAO,SAAS,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAmB;AAC9D,OAAO,EAAa,IAAI,EAAE,aAAa,EAAqB,iBAAiB,EAAE,iBAAgB;AAC/F,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,0BAAyB;AAWlF;;GAEG;AACH,8BAAsB,uBAAuB,CAAC,MAAM,SAAS,OAAO,EAAE,GAAG,OAAO,EAAE;IAChF;;OAEG;IACI,MAAM,EAAE,iBAAiB,CAA0B;IAE1D;;OAEG;IACI,KAAK,CAAC,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACI,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAEpC;;OAEG;IACI,MAAM,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACI,OAAO,CAAC,EAAE,SAAS,CAAC;IAE3B;;OAEG;IACI,SAAS,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACI,WAAW,CAAC,EAAE,SAAS,CAAC;IAE/B;;OAEG;IACI,UAAU,EAAE,OAAO,CAAC;IAE3B;;;;;OAKG;IACH,SAAS,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC;IAE/B;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,yBAAyB,CAAC,MAAM,CAAC,CACF;IAErD;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC;IAEhC;;;;OAIG;IACH,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IAEjC;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC;IAElC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAE3B;;OAEG;gBACS,eAAe,EAAE,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO;IAiB1E;;OAEG;IACU,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAkCjC;;;;;OAKG;YACW,WAAW;IAyGzB;;;;;;OAMG;IACI,cAAc,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI;IAQxE;;;;;;;;OAQG;IACU,gBAAgB,IAAI,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAmC9D;;;;;;OAMG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IA0B5C;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAoBvD;;;;;;OAMG;aACa,eAAe,IAAI,OAAO;IAE1C;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,oBAAoB,CAAC,SAAS,EAAE,kBAAkB,CAAC;IAEnF;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,OAAO;IAQnC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,IAAI,OAAO,CAAC,SAAS,CAAC;IAExD;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAC9B,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAC/E,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,EAClC,KAAK,EAAE,aAAa,EACpB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,IAAI;IAqBP;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAC9B,OAAO,EAAE,CAAC,KAAK,EAAE,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAC9E,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,EACnC,OAAO,EAAE,kBAAkB,GAC1B,IAAI;CAGR"}
+{"version":3,"file":"PolymeshTransactionBase.d.ts","sourceRoot":"","sources":["../../src/base/PolymeshTransactionBase.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,oCAA+B;AAChE,OAAO,EAAE,kBAAkB,EAAiB,MAAM,IAAI,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACpG,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,oBAAmB;AAG9D,OAAO,EAGL,iBAAiB,EAEjB,iBAAiB,EACjB,aAAa,EACd,iBAAgB;AACjB,OAAO,EACL,mBAAmB,EAEnB,qBAAqB,EACrB,sBAAsB,EACvB,0BAAyB;AAa1B;;GAEG;AACH,8BAAsB,uBAAuB,CAC3C,WAAW,GAAG,IAAI,EAClB,sBAAsB,GAAG,WAAW;IAEpC;;OAEG;WACW,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAClC,WAAW,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GACzC,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC;IAU5B;;OAEG;IACI,MAAM,EAAE,iBAAiB,CAA0B;IAE1D;;OAEG;IACI,KAAK,CAAC,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACI,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAEpC;;OAEG;IACI,MAAM,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACI,OAAO,CAAC,EAAE,SAAS,CAAC;IAE3B;;OAEG;IACI,SAAS,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACI,WAAW,CAAC,EAAE,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,SAAS,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC;IAE/B;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEvD;;;;OAIG;IACH,SAAS,CAAC,OAAO,eAAsB;IAEvC;;;;OAIG;IACH,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IAEjC;;;;;OAKG;IACH,SAAS,CAAC,WAAW,CAAC,EAAE,CACtB,MAAM,EAAE,WAAW,KAChB,OAAO,CAAC,sBAAsB,CAAC,GAAG,sBAAsB,CAAC;IAE9D,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAS;IAEvB;;OAEG;gBAED,eAAe,EAAE,mBAAmB,CAAC,WAAW,EAAE,sBAAsB,CAAC,GACvE,sBAAsB,EACxB,OAAO,EAAE,OAAO;IAYlB;;;;;OAKG;IACU,GAAG,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAkEnD;;;;;OAKG;YACW,WAAW;IAiGzB;;;;;;OAMG;IACI,cAAc,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,uBAAuB,KAAK,IAAI,GAAG,aAAa;IAU9F;;;;;OAKG;IACU,YAAY,IAAI,OAAO,CAAC,iBAAiB,CAAC;IA8BvD;;;;;;;;;OASG;IACI,uBAAuB,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,aAAa,KAAK,IAAI,GAAG,aAAa;IAiBtF;;;;;;;OAOG;YACW,0BAA0B;IA4DxC;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAqBvD;;;;;;OAMG;aACa,eAAe,IAAI,OAAO;IAE1C;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,IAAI,oBAAoB,CAAC,SAAS,EAAE,kBAAkB,CAAC;IAGnF;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,OAAO;IAQnC;;;;;OAKG;aACa,eAAe,IAAI,OAAO,CAAC,SAAS,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAC9B,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAC/E,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,EAClC,KAAK,EAAE,sBAAsB,EAC7B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,IAAI;IAqBP;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAC9B,OAAO,EAAE,CAAC,KAAK,EAAE,kBAAkB,GAAG,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAC9E,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,EACnC,OAAO,EAAE,kBAAkB,GAC1B,IAAI;IAIP;;;;;OAKG;YACW,iBAAiB;IA+C/B;;;;;;;;;OASG;YACW,gBAAgB;CAkC/B"}