ExtrinsicV5 TransactionExtension

packages/types-augment/src/registry/interfaces.ts

@@ -34,7 +34,7 @@ import type { ApprovalFlag, DefunctVoter, Renouncing, SetIndex, Vote, VoteIndex,
 import type { CreatedBlock, ImportedAux } from '@polkadot/types/interfaces/engine';
 import type { BlockV0, BlockV1, BlockV2, EIP1559Transaction, EIP2930Transaction, EthAccessList, EthAccessListItem, EthAccount, EthAddress, EthBlock, EthBloom, EthCallRequest, EthFeeHistory, EthFilter, EthFilterAddress, EthFilterChanges, EthFilterTopic, EthFilterTopicEntry, EthFilterTopicInner, EthHeader, EthLog, EthReceipt, EthReceiptV0, EthReceiptV3, EthRichBlock, EthRichHeader, EthStorageProof, EthSubKind, EthSubParams, EthSubResult, EthSyncInfo, EthSyncStatus, EthTransaction, EthTransactionAction, EthTransactionCondition, EthTransactionRequest, EthTransactionSignature, EthTransactionStatus, EthWork, EthereumAccountId, EthereumAddress, EthereumLookupSource, EthereumSignature, LegacyTransaction, TransactionV0, TransactionV1, TransactionV2 } from '@polkadot/types/interfaces/eth';
 import type { EvmAccount, EvmCallInfo, EvmCallInfoV2, EvmCreateInfo, EvmCreateInfoV2, EvmLog, EvmVicinity, EvmWeightInfo, ExitError, ExitFatal, ExitReason, ExitRevert, ExitSucceed } from '@polkadot/types/interfaces/evm';
-import type { AnySignature, EcdsaSignature, Ed25519Signature, Era, Extrinsic, ExtrinsicEra, ExtrinsicPayload, ExtrinsicPayloadUnknown, ExtrinsicPayloadV4, ExtrinsicSignature, ExtrinsicSignatureV4, ExtrinsicUnknown, ExtrinsicV4, ImmortalEra, MortalEra, MultiSignature, Signature, SignerPayload, Sr25519Signature } from '@polkadot/types/interfaces/extrinsics';
+import type { AnySignature, EcdsaSignature, Ed25519Signature, Era, Extrinsic, ExtrinsicEra, ExtrinsicPayload, ExtrinsicPayloadUnknown, ExtrinsicPayloadV4, ExtrinsicPayloadV5, ExtrinsicSignature, ExtrinsicSignatureV4, ExtrinsicSignatureV5, ExtrinsicUnknown, ExtrinsicV4, ExtrinsicV5, ImmortalEra, MortalEra, MultiSignature, Signature, SignerPayload, Sr25519Signature } from '@polkadot/types/interfaces/extrinsics';
 import type { FungiblesAccessError } from '@polkadot/types/interfaces/fungibles';
 import type { AssetOptions, Owner, PermissionLatest, PermissionVersions, PermissionsV1 } from '@polkadot/types/interfaces/genericAsset';
 import type { GenesisBuildErr } from '@polkadot/types/interfaces/genesisBuilder';
@@ -492,12 +492,15 @@ declare module '@polkadot/types/types/registry' {
     ExtrinsicPayload: ExtrinsicPayload;
     ExtrinsicPayloadUnknown: ExtrinsicPayloadUnknown;
     ExtrinsicPayloadV4: ExtrinsicPayloadV4;
+    ExtrinsicPayloadV5: ExtrinsicPayloadV5;
     ExtrinsicSignature: ExtrinsicSignature;
     ExtrinsicSignatureV4: ExtrinsicSignatureV4;
+    ExtrinsicSignatureV5: ExtrinsicSignatureV5;
     ExtrinsicStatus: ExtrinsicStatus;
     ExtrinsicsWeight: ExtrinsicsWeight;
     ExtrinsicUnknown: ExtrinsicUnknown;
     ExtrinsicV4: ExtrinsicV4;
+    ExtrinsicV5: ExtrinsicV5;
     f32: f32;
     F32: F32;
     f64: f64;

packages/types/src/extrinsic/Extrinsic.ts

@@ -3,36 +3,39 @@
 
 import type { AnyJson, AnyTuple, AnyU8a, ArgsDef, IMethod, Inspect, IOption } from '@polkadot/types-codec/types';
 import type { HexString } from '@polkadot/util/types';
-import type { EcdsaSignature, Ed25519Signature, ExtrinsicUnknown, ExtrinsicV4, Sr25519Signature } from '../interfaces/extrinsics/index.js';
+import type { EcdsaSignature, Ed25519Signature, ExtrinsicUnknown, ExtrinsicV5, Sr25519Signature } from '../interfaces/extrinsics/index.js';
 import type { FunctionMetadataLatest } from '../interfaces/metadata/index.js';
 import type { Address, Call, CodecHash, Hash } from '../interfaces/runtime/index.js';
 import type { MultiLocation } from '../interfaces/types.js';
 import type { CallBase, ExtrinsicPayloadValue, ICompact, IExtrinsic, IKeyringPair, INumber, Registry, SignatureOptions } from '../types/index.js';
 import type { GenericExtrinsicEra } from './ExtrinsicEra.js';
-import type { ExtrinsicValueV4 } from './v4/Extrinsic.js';
+// import type { ExtrinsicValueV4 } from './v4/Extrinsic.js';
+import type { ExtrinsicValueV5 } from './v5/Extrinsic.js';
 
 import { AbstractBase } from '@polkadot/types-codec';
 import { compactAddLength, compactFromU8a, compactToU8a, isHex, isU8a, objectProperty, objectSpread, u8aConcat, u8aToHex, u8aToU8a } from '@polkadot/util';
 
-import { EXTRINSIC_VERSION as LATEST_EXTRINSIC_VERSION } from './v4/Extrinsic.js';
+import { EXTRINSIC_VERSION as LATEST_EXTRINSIC_VERSION } from './v5/Extrinsic.js';
 import { BIT_SIGNED, BIT_UNSIGNED, DEFAULT_VERSION, UNMASK_VERSION } from './constants.js';
 
 interface CreateOptions {
   version?: number;
+  subVersionV5?: 'bare' | 'general' | 'signed' | number;
 }
 
 // NOTE The following 2 types, as well as the VERSION structure and the latest export
 // is to be changed with the addition of a new extrinsic version
 
-type ExtrinsicVx = ExtrinsicV4;
-type ExtrinsicValue = ExtrinsicValueV4;
+type ExtrinsicVx = ExtrinsicV5;
+type ExtrinsicValue = ExtrinsicValueV5;
 
 const VERSIONS = [
   'ExtrinsicUnknown', // v0 is unknown
   'ExtrinsicUnknown',
   'ExtrinsicUnknown',
   'ExtrinsicUnknown',
-  'ExtrinsicV4'
+  'ExtrinsicV4',
+  'ExtrinsicV5'
 ];
 
 export { LATEST_EXTRINSIC_VERSION };
@@ -81,7 +84,7 @@ function decodeU8a (registry: Registry, value: Uint8Array, version: number): Ext
 }
 
 abstract class ExtrinsicBase<A extends AnyTuple> extends AbstractBase<ExtrinsicVx | ExtrinsicUnknown> {
-  constructor (registry: Registry, value: ExtrinsicV4 | ExtrinsicUnknown, initialU8aLength?: number) {
+  constructor (registry: Registry, value: ExtrinsicV5 | ExtrinsicUnknown, initialU8aLength?: number) {
     super(registry, value, initialU8aLength);
 
     const signKeys = Object.keys(registry.getSignedExtensionTypes());

packages/types/src/extrinsic/ExtrinsicPayload.ts

@@ -5,7 +5,7 @@ import type { Bytes } from '@polkadot/types-codec';
 import type { AnyJson, BareOpts, Registry } from '@polkadot/types-codec/types';
 import type { HexString } from '@polkadot/util/types';
 import type { BlockHash } from '../interfaces/chain/index.js';
-import type { ExtrinsicPayloadV4 } from '../interfaces/extrinsics/index.js';
+import type { ExtrinsicPayloadV4, ExtrinsicPayloadV5 } from '../interfaces/extrinsics/index.js';
 import type { Hash, MultiLocation } from '../interfaces/types.js';
 import type { ExtrinsicPayloadValue, ICompact, IKeyringPair, INumber, IOption } from '../types/index.js';
 import type { GenericExtrinsicEra } from './ExtrinsicEra.js';
@@ -20,14 +20,15 @@ interface ExtrinsicPayloadOptions {
 }
 
 // all our known types that can be returned
-type ExtrinsicPayloadVx = ExtrinsicPayloadV4;
+type ExtrinsicPayloadVx = ExtrinsicPayloadV4 | ExtrinsicPayloadV5;
 
 const VERSIONS = [
   'ExtrinsicPayloadUnknown', // v0 is unknown
   'ExtrinsicPayloadUnknown',
   'ExtrinsicPayloadUnknown',
   'ExtrinsicPayloadUnknown',
-  'ExtrinsicPayloadV4'
+  'ExtrinsicPayloadV4',
+  'ExtrinsicPayloadV5'
 ];
 
 /** @internal */

packages/types/src/extrinsic/constants.ts

@@ -12,3 +12,9 @@
 export const IMMORTAL_ERA = new Uint8Array([0]);
 
 export const UNMASK_VERSION = 0b01111111;
+
+export const DISCRIMINATOR_V5_MAP = {
+  bare: 0b00000100,
+  signed: 0b10000100,
+  general: 0b01000100
+};

packages/types/src/extrinsic/index.ts

@@ -11,3 +11,4 @@ export { GenericSignerPayload } from './SignerPayload.js';
 
 // all starred
 export * from './v4/index.js';
+export * from './v5/index.js';

packages/types/src/extrinsic/transactionExtesion/emptyCheck.ts

@@ -0,0 +1,9 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ExtInfo } from './types.js';
+
+export const emptyCheck: ExtInfo = {
+  extrinsic: {},
+  payload: {}
+};

packages/types/src/extrinsic/transactionExtesion/index.ts

@@ -0,0 +1,46 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ExtDef, ExtInfo, ExtTypes } from './types.js';
+
+import { objectSpread } from '@polkadot/util';
+
+import { polkadot } from './polkadot.js';
+import { shell } from './shell.js';
+import { statemint } from './statemint.js';
+import { substrate } from './substrate.js';
+
+// A mapping of the known signed extensions to the extra fields that they
+// contain. Unlike in the actual extensions, we define the extra fields not
+// as a Tuple, but rather as a struct so they can be named. These will be
+// expanded into the various fields when added to the payload (we only
+// support V4 onwards with these, V3 and earlier are deemed fixed))
+export const allExtensions: ExtDef = objectSpread({}, substrate, polkadot, shell, statemint);
+
+// the v4 signed extensions prior to the point of exposing these to the
+// metadata. This may not match 100% with the current defaults and are used
+// when not specified in the metadata (which is for very old chains). The
+// order is important here, as applied by default
+export const fallbackExtensions = [
+  'CheckVersion',
+  'CheckGenesis',
+  'CheckEra',
+  'CheckNonce',
+  'CheckWeight',
+  'ChargeTransactionPayment',
+  'CheckBlockGasLimit'
+];
+
+export function findUnknownExtensions (extensions: string[], userExtensions: ExtDef = {}): string[] {
+  const names = [...Object.keys(allExtensions), ...Object.keys(userExtensions)];
+
+  return extensions.filter((k) => !names.includes(k));
+}
+
+export function expandExtensionTypes (extensions: string[], type: keyof ExtInfo, userExtensions: ExtDef = {}): ExtTypes {
+  return extensions
+    // Always allow user extensions first - these should provide overrides
+    .map((k) => userExtensions[k] || allExtensions[k])
+    .filter((info): info is ExtInfo => !!info)
+    .reduce((result, info): ExtTypes => objectSpread(result, info[type]), {});
+}

packages/types/src/extrinsic/transactionExtesion/polkadot.ts

@@ -0,0 +1,15 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ExtDef } from './types.js';
+
+import { emptyCheck } from './emptyCheck.js';
+
+export const polkadot: ExtDef = {
+  LimitParathreadCommits: emptyCheck,
+  OnlyStakingAndClaims: emptyCheck,
+  PrevalidateAttests: emptyCheck,
+  RestrictFunctionality: emptyCheck,
+  TransactionCallFilter: emptyCheck,
+  ValidateDoubleVoteReports: emptyCheck
+};

packages/types/src/extrinsic/transactionExtesion/shell.ts

@@ -0,0 +1,10 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ExtDef } from './types.js';
+
+import { emptyCheck } from './emptyCheck.js';
+
+export const shell: ExtDef = {
+  DisallowSigned: emptyCheck
+};

packages/types/src/extrinsic/transactionExtesion/statemint.ts

@@ -0,0 +1,15 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ExtDef } from './types.js';
+
+export const statemint: ExtDef = {
+  ChargeAssetTxPayment: {
+    extrinsic: {
+      tip: 'Compact<Balance>',
+      // eslint-disable-next-line sort-keys
+      assetId: 'TAssetConversion'
+    },
+    payload: {}
+  }
+};

packages/types/src/extrinsic/transactionExtesion/substrate.ts

@@ -0,0 +1,74 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ExtDef, ExtInfo } from './types.js';
+
+import { emptyCheck } from './emptyCheck.js';
+
+const CheckMetadataHash: ExtInfo = {
+  extrinsic: {
+    mode: 'u8'
+  },
+  payload: {
+    metadataHash: 'Option<[u8;32]>'
+  }
+};
+
+const CheckMortality: ExtInfo = {
+  extrinsic: {
+    era: 'ExtrinsicEra'
+  },
+  payload: {
+    blockHash: 'Hash'
+  }
+};
+
+const ChargeTransactionPayment: ExtInfo = {
+  extrinsic: {
+    tip: 'Compact<Balance>'
+  },
+  payload: {}
+};
+
+export const substrate: ExtDef = {
+  ChargeTransactionPayment,
+  CheckBlockGasLimit: emptyCheck,
+  CheckEra: CheckMortality,
+  CheckGenesis: {
+    extrinsic: {},
+    payload: {
+      genesisHash: 'Hash'
+    }
+  },
+  CheckMetadataHash,
+  CheckMortality,
+  CheckNonZeroSender: emptyCheck,
+  CheckNonce: {
+    extrinsic: {
+      nonce: 'Compact<Index>'
+    },
+    payload: {}
+  },
+  CheckSpecVersion: {
+    extrinsic: {},
+    payload: {
+      specVersion: 'u32'
+    }
+  },
+  CheckTxVersion: {
+    extrinsic: {},
+    payload: {
+      transactionVersion: 'u32'
+    }
+  },
+  CheckVersion: {
+    extrinsic: {},
+    payload: {
+      specVersion: 'u32'
+    }
+  },
+  CheckWeight: emptyCheck,
+  LockStakingStatus: emptyCheck,
+  SkipCheckIfFeeless: ChargeTransactionPayment,
+  ValidateEquivocationReport: emptyCheck
+};

packages/types/src/extrinsic/transactionExtesion/types.ts

@@ -0,0 +1,11 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export type ExtTypes = Record<string, string>;
+
+export interface ExtInfo {
+  extrinsic: ExtTypes;
+  payload: ExtTypes;
+}
+
+export type ExtDef = Record<string, ExtInfo>;

packages/types/src/extrinsic/v5/Extrinsic.spec.ts

@@ -0,0 +1,86 @@
+// Copyright 2017-2024 @polkadot/types authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { createTestPairs } from '@polkadot/keyring/testingPairs';
+import rpcMetadata from '@polkadot/types-support/metadata/v14/substrate-hex-extrinsic-v5';
+import { BN } from '@polkadot/util';
+
+import { TypeRegistry } from '../../create/index.js';
+import { decorateExtrinsics, Metadata } from '../../metadata/index.js';
+import { GenericExtrinsicV5 as Extrinsic } from './index.js';
+
+const registry = new TypeRegistry();
+const metadata = new Metadata(registry, rpcMetadata);
+const keyring = createTestPairs({ type: 'ed25519' }, false);
+
+registry.setMetadata(metadata);
+
+const tx = decorateExtrinsics(registry, metadata.asLatest, metadata.version);
+
+describe('ExtrinsicV5', (): void => {
+  it('constructs a sane Uint8Array (default)', (): void => {
+    const xt = new Extrinsic(registry);
+
+    // expect(`${xt.method.section}${xt.method.method}`).toEqual('system.fillBlock');
+    expect(`${xt.method.section}.${xt.method.method}`).toEqual('system.remark');
+
+    expect(xt.toU8a()).toEqual(new Uint8Array([
+      0, 0, // index
+      // 0, 0, 0, 0 // fillBlock, Perbill
+      0 // remark, Vec<u8>
+    ]));
+  });
+
+  it('creates a unsigned extrinsic', (): void => {
+    expect(
+      new Extrinsic(
+        registry,
+        tx['balances']['transferAllowDeath'](keyring.bob.publicKey, 6969n)
+      ).toHex()
+    ).toEqual(
+      '0x' +
+      '0600' + // balance.transferAllowDeath
+      '00' +
+      'd7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9' +
+      'e56c'
+    );
+  });
+
+  it('creates a signed extrinsic', (): void => {
+    expect(
+      new Extrinsic(
+        registry,
+        tx['balances']['transferAllowDeath'](keyring.bob.publicKey, 6969n)
+      ).sign(keyring.alice, {
+        blockHash: '0xec7afaf1cca720ce88c1d1b689d81f0583cc15a97d621cf046dd9abf605ef22f',
+        genesisHash: '0xdcd1346701ca8396496e52aa2785b1748deb6db09551b72159dcb3e08991025b',
+        mode: 0,
+        nonce: 1,
+        runtimeVersion: {
+          apis: [],
+          authoringVersion: new BN(123),
+          implName: 'test',
+          implVersion: new BN(123),
+          specName: 'test',
+          specVersion: new BN(123),
+          transactionVersion: new BN(123)
+        },
+        tip: 2
+      }).toHex()
+    ).toEqual(
+      '0x' +
+      '00' +
+      'd172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f' +
+      '00' + // ed25519
+      'bac8e442c7d6e6827fe3b72a2dee6bd036e059e1b0a2a5cfb00ec39184d60536' +
+      'a4f3b5f3bfcd31e6e5b5cf6482914dc989fbe9483043a13c90376dfe28c5e00f' +
+      '0004080000' + // era. nonce, tip, mode
+      '0600' +
+      '00' +
+      'd7568e5f0a7eda67a82691ff379ac4bba4f9c9b859fe779b5d46363b61ad2db9' +
+      'e56c'
+    );
+  });
+});