api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 12.0.2

github-actions[bot] · github-actions[bot] · commit 245a40b0f750 · 2024-06-27T21:03:35.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## master
 
+- api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 12.0.2
 - phishing 0.22.10
 - api, api-{augment, base, contract, derive}, rpc-{augment, core, provider}, types, types-{augment, codec, create, known} 12.0.1
 - phishing 0.22.9
diff --git a/api-augment/packageInfo.ts b/api-augment/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/api-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/api-base/packageInfo.ts b/api-base/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api-base', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/api-base', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/api-base/types/submittable.ts b/api-base/types/submittable.ts
@@ -17,6 +17,7 @@ export interface SignerOptions {
   assetId?: AnyNumber | object;
   mode?: AnyNumber;
   metadataHash?: AnyU8a;
+  withSignedTransaction?: boolean;
 }
 
 export type SubmittableDryRunResult<ApiType extends ApiTypes> =
@@ -64,6 +65,15 @@ export interface SubmittableExtrinsic<ApiType extends ApiTypes, R extends ISubmi
 
   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>;
 
   /**
diff --git a/api-contract/packageInfo.ts b/api-contract/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api-contract', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/api-contract', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/api-derive/packageInfo.ts b/api-derive/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api-derive', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/api-derive', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/api/packageInfo.ts b/api/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/api', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/api', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/api/submittable/createClass.ts b/api/submittable/createClass.ts
@@ -338,16 +338,37 @@ export function createClass <ApiType extends ApiTypes> ({ api, apiType, blockHas
       if (isFunction(signer.signPayload)) {
         result = await signer.signPayload(payload.toPayload());
 
-        // When the signedTransaction is included by the signer, we no longer add
-        // the signature to the parent class, but instead broadcast the signed transaction directly.
-        if (result.signedTransaction) {
+        if (result.signedTransaction && !options.withSignedTransaction) {
+          throw new Error('The `signedTransaction` field may not be submitted when `withSignedTransaction` is disabled');
+        }
+
+        if (result.signedTransaction && options.withSignedTransaction) {
           const ext = this.registry.createTypeUnsafe<Extrinsic>('Extrinsic', [result.signedTransaction]);
+          const newSignerPayload = this.registry.createTypeUnsafe<SignerPayload>('SignerPayload', [objectSpread({}, {
+            address,
+            assetId: ext.assetId ? ext.assetId.toHex() : null,
+            blockHash: payload.blockHash,
+            blockNumber: header ? header.number : 0,
+            era: ext.era.toHex(),
+            genesisHash: payload.genesisHash,
+            metadataHash: ext.metadataHash ? ext.metadataHash.toHex() : null,
+            method: ext.method.toHex(),
+            mode: ext.mode ? ext.mode.toHex() : null,
+            nonce: ext.nonce.toHex(),
+            runtimeVersion: payload.runtimeVersion,
+            signedExtensions: payload.signedExtensions,
+            tip: ext.tip.toHex(),
+            version: payload.version
+          })]);
 
           if (!ext.isSigned) {
             throw new Error(`When using the signedTransaction field, the transaction must be signed. Recieved isSigned: ${ext.isSigned}`);
           }
 
           this.#validateSignedTransaction(payload, ext);
+          // This is only used for signAsync - signAndSend does not need to adjust the super payload or
+          // add the signature.
+          super.addSignature(address, result.signature, newSignerPayload.toPayload());
 
           return { id: result.id, signedTransaction: result.signedTransaction };
         }
diff --git a/rpc-augment/packageInfo.ts b/rpc-augment/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/rpc-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/rpc-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/rpc-core/packageInfo.ts b/rpc-core/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/rpc-core', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/rpc-core', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/rpc-provider/packageInfo.ts b/rpc-provider/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/rpc-provider', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/rpc-provider', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/types-augment/packageInfo.ts b/types-augment/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/types-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/types-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/types-augment/registry/interfaces.ts b/types-augment/registry/interfaces.ts
@@ -71,6 +71,7 @@ import type { ClassDetails, ClassId, ClassMetadata, DepositBalance, DepositBalan
 import type { Multisig, Timepoint } from 'https://deno.land/x/polkadot/types/interfaces/utility/index.ts';
 import type { VestingInfo } from 'https://deno.land/x/polkadot/types/interfaces/vesting/index.ts';
 import type { AssetInstance, AssetInstanceV0, AssetInstanceV1, AssetInstanceV2, BodyId, BodyPart, DoubleEncodedCall, Fungibility, FungibilityV0, FungibilityV1, FungibilityV2, InboundStatus, InstructionV2, InteriorMultiLocation, Junction, JunctionV0, JunctionV1, JunctionV2, Junctions, JunctionsV1, JunctionsV2, MultiAsset, MultiAssetFilter, MultiAssetFilterV1, MultiAssetFilterV2, MultiAssetV0, MultiAssetV1, MultiAssetV2, MultiAssets, MultiAssetsV1, MultiAssetsV2, MultiLocation, MultiLocationV0, MultiLocationV1, MultiLocationV2, NetworkId, OriginKindV0, OriginKindV1, OriginKindV2, OutboundStatus, Outcome, QueryId, QueryStatus, QueueConfigData, Response, ResponseV0, ResponseV1, ResponseV2, ResponseV2Error, ResponseV2Result, VersionMigrationStage, VersionedMultiAsset, VersionedMultiAssets, VersionedMultiLocation, VersionedResponse, VersionedXcm, WeightLimitV2, WildFungibility, WildFungibilityV0, WildFungibilityV1, WildFungibilityV2, WildMultiAsset, WildMultiAssetV1, WildMultiAssetV2, Xcm, XcmAssetId, XcmError, XcmErrorV0, XcmErrorV1, XcmErrorV2, XcmOrder, XcmOrderV0, XcmOrderV1, XcmOrderV2, XcmOrigin, XcmOriginKind, XcmV0, XcmV1, XcmV2, XcmVersion, XcmpMessageFormat } from 'https://deno.land/x/polkadot/types/interfaces/xcm/index.ts';
+import type { Error } from 'https://deno.land/x/polkadot/types/interfaces/xcmRuntimeApi/index.ts';
 
 declare module 'https://deno.land/x/polkadot/types/types/registry.ts' {
   interface InterfaceTypes {
@@ -397,6 +398,7 @@ declare module 'https://deno.land/x/polkadot/types/types/registry.ts' {
     EraPoints: EraPoints;
     EraRewardPoints: EraRewardPoints;
     EraRewards: EraRewards;
+    Error: Error;
     ErrorMetadataLatest: ErrorMetadataLatest;
     ErrorMetadataV10: ErrorMetadataV10;
     ErrorMetadataV11: ErrorMetadataV11;
diff --git a/types-codec/packageInfo.ts b/types-codec/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/types-codec', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/types-codec', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/types-create/packageInfo.ts b/types-create/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/types-create', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/types-create', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/types-known/packageInfo.ts b/types-known/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/types-known', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/types-known', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/types/extrinsic/SignerPayload.ts b/types/extrinsic/SignerPayload.ts
@@ -1,5 +1,5 @@
 
-import type { Text, Vec } from 'https://deno.land/x/polkadot/types-codec/mod.ts';
+import type { bool, Text, Vec } from 'https://deno.land/x/polkadot/types-codec/mod.ts';
 import type { AnyJson, Registry } from 'https://deno.land/x/polkadot/types-codec/types/index.ts';
 import type { HexString } from 'https://deno.land/x/polkadot/util/types.ts';
 import type { Address, BlockHash, Call, ExtrinsicEra, Hash, MultiLocation } from '../interfaces/index.ts';
@@ -53,7 +53,7 @@ export class GenericSignerPayload extends Struct implements ISignerPayload, Sign
   constructor (registry: Registry, value?: HexString | Record<string, unknown> | Map<unknown, unknown> | unknown[]) {
     const extensionTypes = objectSpread<Record<string, string>>({}, registry.getSignedExtensionTypes(), registry.getSignedExtensionExtra());
 
-    super(registry, objectSpread<Record<string, string>>({}, extensionTypes, knownTypes), value);
+    super(registry, objectSpread<Record<string, string>>({}, extensionTypes, knownTypes, { withSignedTransaction: 'bool' }), value);
 
     this.#extraTypes = {};
     const getter = (key: string) => this.get(key);
@@ -124,6 +124,12 @@ export class GenericSignerPayload extends Struct implements ISignerPayload, Sign
     return this.getT('metadataHash');
   }
 
+  get withSignedTransaction (): boolean {
+    const val: bool = this.getT('withSignedTransaction');
+
+    return val.isTrue;
+  }
+
   /**
    * @description Creates an representation of the structure as an ISignerPayload JSON
    */
@@ -164,7 +170,8 @@ export class GenericSignerPayload extends Struct implements ISignerPayload, Sign
       specVersion: this.runtimeVersion.specVersion.toHex(),
       tip: this.tip.toHex(),
       transactionVersion: this.runtimeVersion.transactionVersion.toHex(),
-      version: this.version.toNumber()
+      version: this.version.toNumber(),
+      withSignedTransaction: this.withSignedTransaction
     });
   }
 
diff --git a/types/interfaces/definitions.ts b/types/interfaces/definitions.ts
@@ -60,7 +60,9 @@ export { default as finality } from './finality/definitions.ts';
 export { default as parachains } from './parachains/definitions.ts';
 export { default as poll } from './poll/definitions.ts';
 export { default as purchase } from './purchase/definitions.ts';
+
 export { default as xcm } from './xcm/definitions.ts';
+export { default as xcmRuntimeApi } from './xcmRuntimeApi/definitions.ts';
 
 export { default as contractsAbi } from './contractsAbi/definitions.ts';
 export { default as eth } from './eth/definitions.ts';
diff --git a/types/interfaces/types.ts b/types/interfaces/types.ts
@@ -74,3 +74,4 @@ export * from './uniques/types.ts';
 export * from './utility/types.ts';
 export * from './vesting/types.ts';
 export * from './xcm/types.ts';
+export * from './xcmRuntimeApi/types.ts';
diff --git a/types/interfaces/xcmRuntimeApi/definitions.ts b/types/interfaces/xcmRuntimeApi/definitions.ts
@@ -0,0 +1,16 @@
+
+/* eslint-disable sort-keys */
+
+import type { Definitions } from '../../types/index.ts';
+
+import { runtime } from './runtime.ts';
+
+export default {
+  rpc: {},
+  runtime,
+  types: {
+    Error: {
+      _enum: ['Unsupported', 'VersionedConversionFailed']
+    }
+  }
+} as Definitions;
diff --git a/types/interfaces/xcmRuntimeApi/index.ts b/types/interfaces/xcmRuntimeApi/index.ts
@@ -0,0 +1,3 @@
+/* eslint-disable */
+
+export * from './types.ts';
diff --git a/types/interfaces/xcmRuntimeApi/runtime.ts b/types/interfaces/xcmRuntimeApi/runtime.ts
@@ -0,0 +1,22 @@
+
+import type { DefinitionsCall } from '../../types/index.ts';
+
+export const runtime: DefinitionsCall = {
+  LocationToAccountApi: [
+    {
+      methods: {
+        convert_location: {
+          description: 'Converts `Location` to `AccountId`',
+          params: [
+            {
+              name: 'location',
+              type: 'XcmVersionedLocation'
+            }
+          ],
+          type: 'Result<AccountId, Error>'
+        }
+      },
+      version: 1
+    }
+  ]
+};
diff --git a/types/interfaces/xcmRuntimeApi/types.ts b/types/interfaces/xcmRuntimeApi/types.ts
@@ -0,0 +1,12 @@
+/* eslint-disable */
+
+import type { Enum } from 'https://deno.land/x/polkadot/types-codec/mod.ts';
+
+/** @name Error */
+export interface Error extends Enum {
+  readonly isUnsupported: boolean;
+  readonly isVersionedConversionFailed: boolean;
+  readonly type: 'Unsupported' | 'VersionedConversionFailed';
+}
+
+export type PHANTOM_XCMRUNTIMEAPI = 'xcmRuntimeApi';
diff --git a/types/packageInfo.ts b/types/packageInfo.ts
@@ -1,3 +1,3 @@
 
 
-export const packageInfo = { name: '@polkadot/types', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };
+export const packageInfo = { name: '@polkadot/types', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };
diff --git a/types/types/extrinsic.ts b/types/types/extrinsic.ts
@@ -102,6 +102,12 @@ export interface SignerPayloadJSON {
    * @description The version of the extrinsic we are dealing with
    */
   version: number;
+
+  /**
+   * @description Optional flag that enables the use of the `signedTransaction` field in
+   * `singAndSend`, `signAsync`, and `dryRun`.
+   */
+  withSignedTransaction?: boolean;
 }
 
 export interface SignerPayloadRawBase {
@@ -150,7 +156,9 @@ export interface SignerResult {
    * and instead broadcasting the transaction directly. There is a small validation layer. Please refer
    * to the implementation for more information. If the inputted signed transaction is not actually signed, it will fail with an error.
    *
-   * NOTE: This is only implemented for `signPayload`.
+   * This will also work for `signAsync`. The new payload will be added to the Extrinsic, and will be sent once the consumer calls `.send()`.
+   *
+   * NOTE: This is only implemented for `signPayload`, and will only work when the `withSignedTransaction` option is enabled as an option.
    */
   signedTransaction?: HexString | Uint8Array;
 }
@@ -189,6 +197,7 @@ export interface SignatureOptions {
   assetId?: AnyNumber | object;
   mode?: AnyNumber;
   metadataHash?: Uint8Array | string;
+  withSignedTransaction?: boolean;
 }
 
 interface ExtrinsicSignatureBase {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`
`2`	`2`
`3`		`-export const packageInfo = { name: '@polkadot/api-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.1' };`
	`3`	`+export const packageInfo = { name: '@polkadot/api-augment', path: new URL(import.meta.url).pathname, type: 'deno', version: '12.0.2' };`