feat(txwrapper-polkadot): Add support for Statemint & Statemine

README.md

@@ -19,7 +19,7 @@ For example, those looking to construct a transaction offline on Polkadot would
 
 #### Published
 
-- [@substrate/txwrapper-polkadot](/packages/txwrapper-polkadot/README.md) Helper functions for Polkadot, Kusama, Rococo and Westend offline transaction generation.
+- [@substrate/txwrapper-polkadot](/packages/txwrapper-polkadot/README.md) Helper functions for offline transaction generation for polkadot relay and system chains; specifically the following chains: Polkadot, Kusama, Rococo, Westend, Statemint and Statemine.
 - [@substrate/txwrapper-core](/packages/txwrapper-core/README.md) The essentials for creating a chain specific txwrapper lib.
 - [@substrate/txwrapper-registry](/packages/txwrapper-registry/README.md) Registry creation support, catering to chains with types in [@polkadot/apps-config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config/README.md).
 - [@substrate/txwrapper-substrate](/packages/txwrapper-substrate/README.md) Selected dispatchables of Substrate pallets, to be re-exported by txwrappers (e.g. @substrate/txwrapper-polkadot).

packages/txwrapper-acala/src/index.ts

@@ -57,7 +57,7 @@ export function getRegistry({
 }: GetRegistryOpts): TypeRegistry {
 	const registry = new TypeRegistry();
 	registry.setKnownTypes({
-		typesBundle: (typesBundleForPolkadot as unknown) as OverrideBundleType,
+		typesBundle: typesBundleForPolkadot as unknown as OverrideBundleType,
 	});
 
 	return getRegistryBase({

packages/txwrapper-core/src/core/decode/decode.spec.ts

@@ -62,10 +62,10 @@ describe('decode', () => {
 			POLKADOT_25_TEST_OPTIONS
 		);
 
-		const decoded = (decode(
+		const decoded = decode(
 			signingPayload,
 			POLKADOT_25_TEST_OPTIONS
-		) as unknown) as DecodedSigningPayload;
+		) as unknown as DecodedSigningPayload;
 
 		itDecodesSigningPayloadBalancesTransfer(decoded);
 

packages/txwrapper-core/src/core/decode/decodeSigningPayload.spec.ts

@@ -12,16 +12,16 @@ import { itDecodesBalancesTransferCommon } from './test-helpers';
 export function itDecodesSigningPayloadBalancesTransfer(
 	decoded: DecodedSigningPayload
 ): void {
-	([
-		'blockHash',
-		'genesisHash',
-		'metadataRpc',
-		'nonce',
-		'specVersion',
-		'tip',
-	] as const).forEach((key) =>
-		expect(decoded[key]).toBe(TEST_BASE_TX_INFO[key])
-	);
+	(
+		[
+			'blockHash',
+			'genesisHash',
+			'metadataRpc',
+			'nonce',
+			'specVersion',
+			'tip',
+		] as const
+	).forEach((key) => expect(decoded[key]).toBe(TEST_BASE_TX_INFO[key]));
 }
 
 describe('decodeSigningPayload', () => {

packages/txwrapper-core/src/core/decode/decodeUnsignedTx.spec.ts

@@ -11,19 +11,19 @@ import { itDecodesBalancesTransferCommon } from './test-helpers';
 export function itDecodesUnsignedBalanceTransferTx(
 	decoded: DecodedUnsignedTx
 ): void {
-	([
-		'address',
-		'blockHash',
-		'blockNumber',
-		'genesisHash',
-		'metadataRpc',
-		'nonce',
-		'specVersion',
-		'transactionVersion',
-		'tip',
-	] as const).forEach((key) =>
-		expect(decoded[key]).toBe(TEST_BASE_TX_INFO[key])
-	);
+	(
+		[
+			'address',
+			'blockHash',
+			'blockNumber',
+			'genesisHash',
+			'metadataRpc',
+			'nonce',
+			'specVersion',
+			'transactionVersion',
+			'tip',
+		] as const
+	).forEach((key) => expect(decoded[key]).toBe(TEST_BASE_TX_INFO[key]));
 }
 
 describe('decodeUnsignedTx', () => {

packages/txwrapper-core/src/core/method/defineMethod.ts

@@ -39,7 +39,7 @@ export function defineMethod(
 
 	const methodFunction =
 		!!tx[info.method.pallet] &&
-		((tx[info.method.pallet] as unknown) as ModuleExtrinsics)[info.method.name];
+		(tx[info.method.pallet] as unknown as ModuleExtrinsics)[info.method.name];
 	if (!methodFunction) {
 		throw new Error('pallet or method not found in metadata');
 	}

packages/txwrapper-core/src/core/method/toTxMethod.ts

@@ -21,7 +21,7 @@ import { Args, TxMethod } from '../../types/method';
 export function toTxMethod(registry: TypeRegistry, method: Call): TxMethod {
 	// Mapping of argName->argType
 	// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-	const argsDef = JSON.parse((method.Type.args as unknown) as string);
+	const argsDef = JSON.parse(method.Type.args as unknown as string);
 	// Mapping of argName->argValue
 	const args = Object.keys(argsDef).reduce((accumulator, key, index) => {
 		let codec = createTypeUnsafe(registry, argsDef[key], [method.args[index]]);

packages/txwrapper-orml/src/test-helpers/getRegistryMandala.ts

@@ -16,7 +16,7 @@ export function getRegistryMandala(
 ): TypeRegistry {
 	const registry = new TypeRegistry();
 	registry.setKnownTypes({
-		typesBundle: (typesBundleForPolkadot as unknown) as OverrideBundleType,
+		typesBundle: typesBundleForPolkadot as unknown as OverrideBundleType,
 	});
 
 	return getRegistryBase({

packages/txwrapper-polkadot/README.md

@@ -17,6 +17,12 @@
 
 <br /><br />
 
+# About
+
+Txwrapper library for polkadot relay and system chains; specifically Polkadot, Kusama, Rococo, Westend, Statemint and Statemine.
+
+Note: not all methods available apply to all supported chains. To check what methods are supported by a chain consult the pallets included in chain's runtime.
+
 
 ## Get Started
 

packages/txwrapper-polkadot/src/index.ts

@@ -9,7 +9,8 @@ import { methods as substrateMethods } from '@substrate/txwrapper-substrate';
 
 import * as polkadotMethods from './methods';
 
-// Export methods of pallets included in the Polkadot/ Kusama/ Westend runtimes.
+// Export methods of pallets included in the Polkadot, Kusama, Westend, Rococo
+// and State{mint, mine} runtimes.
 // Note: in the future this may also include methods defined within this package
 // that do not exist in Substrate.
 export const methods = {
@@ -23,6 +24,8 @@ export const methods = {
 	vesting: substrateMethods.vesting,
 	multisig: substrateMethods.multisig,
 	crowdloan: polkadotMethods.crowdloan,
+	// assets is only applicable to State{mint, mine}
+	assets: substrateMethods.assets,
 };
 
 // Re-export all of txwrapper-core so users have access to utilities, construct functions,
@@ -49,6 +52,16 @@ const KNOWN_CHAIN_PROPERTIES = {
 		tokenDecimals: 12,
 		tokenSymbol: 'WND',
 	},
+	statemint: {
+		ss58Format: PolkadotSS58Format.polkadot,
+		tokenDecimals: 10,
+		tokenSymbol: 'DOT',
+	},
+	statemine: {
+		ss58Format: PolkadotSS58Format.kusama,
+		tokenDecimals: 12,
+		tokenSymbol: 'KSM',
+	},
 };
 
 // We override the `specName` property of `GetRegistryOptsCore` in order to get narrower type specificity,
@@ -75,9 +88,18 @@ export function getRegistry({
 	// The default type registry has polkadot types
 	const registry = new TypeRegistry();
 
+	// As of now statemine is not a supported specName in the default polkadot-js/api type registry.
+	const chainNameAdjusted = chainName === 'Statemine' ? 'Statemint' : chainName;
+	const specNameAdjusted = specName === 'statemine' ? 'statemint' : specName;
+
 	return getRegistryBase({
 		chainProperties: properties || KNOWN_CHAIN_PROPERTIES[specName],
-		specTypes: getSpecTypes(registry, chainName, specName, specVersion),
+		specTypes: getSpecTypes(
+			registry,
+			chainNameAdjusted,
+			specNameAdjusted,
+			specVersion
+		),
 		metadataRpc,
 	});
 }

packages/txwrapper-substrate/src/methods/assets/approveTransfer.ts

@@ -19,7 +19,7 @@ export interface AssetsApproveTransferArgs extends Args {
 	 * The amount of asset that may be transferred by `delegate`. If there is
 	 * already an approval in place, then this acts additively.
 	 */
-	amount: number;
+	amount: number | string;
 }
 
 /**

packages/txwrapper-substrate/src/methods/assets/transfer.ts

@@ -21,7 +21,7 @@ export interface AssetsTransferArgs extends Args {
 	 * the case that the transfer would otherwise take the sender balance above zero but below
 	 * the minimum balance. Must be greater than zero.
 	 */
-	amount: number;
+	amount: number | string;
 }
 
 /**

packages/txwrapper-substrate/src/methods/assets/transferApproved.ts

@@ -23,7 +23,7 @@ export interface AssetsTransferApprovedArgs extends Args {
 	/**
 	 * The amount of assets to transfer.
 	 */
-	amount: number;
+	amount: number | string;
 }
 
 /**

packages/txwrapper-substrate/src/methods/assets/transferKeepAlive.ts

@@ -21,7 +21,7 @@ export interface AssetsTransferKeepAliveArgs extends Args {
 	 * the case that the transfer would otherwise take the sender balance above zero but below
 	 * the minimum balance. Must be greater than zero.
 	 */
-	amount: number;
+	amount: number | string;
 }
 
 /**

packages/txwrapper-substrate/src/test-helpers/TEST_METHOD_ARGS.ts

@@ -66,14 +66,12 @@ export const TEST_METHOD_ARGS = {
 			delegate: 'HNZata7iMYWmk5RvZRTiAsSDhV8366zq2YGb3tLH5Upf74F', // seed "//Alice"
 			real: '14E5nqKAp3oAJcmzgZhUD2RcptBeUBScxKHgJKU4HPNcKVf3', // seed "//Bob",
 			forceProxyType: 'Any',
-			call:
-				'0x0500306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc200f00a0be1c448399',
+			call: '0x0500306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc200f00a0be1c448399',
 		},
 		proxy: {
 			real: '14E5nqKAp3oAJcmzgZhUD2RcptBeUBScxKHgJKU4HPNcKVf3', // seed "//Bob",
 			forceProxyType: 'Any',
-			call:
-				'0x0500306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc200f00a0be1c448399',
+			call: '0x0500306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc200f00a0be1c448399',
 		},
 		anonymous: {
 			proxyType: 'Any',
@@ -178,8 +176,7 @@ export const TEST_METHOD_ARGS = {
 				height: 123,
 				index: 3,
 			},
-			call:
-				'0x0500306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc200f00a0be1c448399',
+			call: '0x0500306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc200f00a0be1c448399',
 			storeCall: false,
 			maxWeight: '90071992547409910',
 		},