@polkadot/api-base 11.3.1 → 12.0.2

package/cjs/packageInfo.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageInfo = void 0;
-exports.packageInfo = { name: '@polkadot/api-base', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '11.3.1' };
+exports.packageInfo = { name: '@polkadot/api-base', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '12.0.2' };

package/package.json

@@ -18,7 +18,7 @@
     "./cjs/packageDetect.js"
   ],
   "type": "module",
-  "version": "11.3.1",
+  "version": "12.0.2",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -127,8 +127,8 @@
     }
   },
   "dependencies": {
-    "@polkadot/rpc-core": "11.3.1",
-    "@polkadot/types": "11.3.1",
+    "@polkadot/rpc-core": "12.0.2",
+    "@polkadot/types": "12.0.2",
     "@polkadot/util": "^12.6.2",
     "rxjs": "^7.8.1",
     "tslib": "^2.6.2"

package/packageInfo.js

@@ -1 +1 @@
-export const packageInfo = { name: '@polkadot/api-base', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '11.3.1' };
+export const packageInfo = { name: '@polkadot/api-base', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '12.0.2' };

package/types/submittable.d.ts

@@ -13,6 +13,7 @@ export interface SignerOptions {
     assetId?: AnyNumber | object;
     mode?: AnyNumber;
     metadataHash?: AnyU8a;
+    withSignedTransaction?: boolean;
 }
 export type SubmittableDryRunResult<ApiType extends ApiTypes> = ApiType extends 'rxjs' ? Observable<ApplyExtrinsicResult> : Promise<ApplyExtrinsicResult>;
 export type SubmittableResultResult<ApiType extends ApiTypes, R extends ISubmittableResult = ISubmittableResult> = ApiType extends 'rxjs' ? Observable<R> : Promise<Hash>;
@@ -37,7 +38,26 @@ export interface SubmittableExtrinsic<ApiType extends ApiTypes, R extends ISubmi
     paymentInfo(account: AddressOrPair, options?: Partial<SignerOptions>): SubmittablePaymentResult<ApiType>;
     send(): SubmittableResultResult<ApiType>;
     send(statusCb: Callback<R>): SubmittableResultSubscription<ApiType, R>;
+    /**
+     * @description Sign and broadcast the constructued transaction.
+     *
+     * Note for injected signers:
+     * As of v12.0.2 and up the `SignerResult` return type for `signPayload` allows for the `signedTransaction` field.
+     * This allows the signer to input a signed transaction that will modify the payload. This
+     * The api will ensure that the Call Data is not changed. This allows for the signer to modify the payload to add
+     * things like `mode`, and `metadataHash` for signedExtensions such as `CheckMetadataHash`.
+     */
     signAsync(account: AddressOrPair, _options?: Partial<SignerOptions>): PromiseOrObs<ApiType, this>;
+    /**
+     * @description Sign and broadcast the constructued transaction.
+     *
+     * Note for injected signers:
+     * As of v12.0.1 and up the `SignerResult` return type for `signPayload` allows for the `signedTransaction` field.
+     * This allows the signer to input a signed transaction that will be directly broadcasted. This
+     * bypasses the api adding the signature to the payload. The api will ensure that the Call Data is not changed before it broadcasts the
+     * transaction. This allows for the signer to modify the payload to add things like `mode`, and `metadataHash` for
+     * signedExtensions such as `CheckMetadataHash`.
+     */
     signAndSend(account: AddressOrPair, options?: Partial<SignerOptions>): SubmittableResultResult<ApiType, R>;
     signAndSend(account: AddressOrPair, statusCb: Callback<R>): SubmittableResultSubscription<ApiType>;
     signAndSend(account: AddressOrPair, options: Partial<SignerOptions>, statusCb?: Callback<R>): SubmittableResultSubscription<ApiType, R>;