Add E2E tests for revamped recovery pallet (#602)

* Add Asset Hub Westend chain and westend network group

* Add recovery pallet E2E test module

* Add Asset Hub Westend recovery E2E entrypoint

* Remove redundant conditional in completeRecovery helper

* Improve type safety in recovery test helpers

* Adapt recovery tests to master SDK runtime

- Rename `inheritanceOrder` to `inheritancePriority` following field rename in pallet
- Rename `LowerOrderRecovered` to `HigherPriorityRecovered` following error rename
- Increase `cancelDelay` in `cancelBeforeDelayFailsTest` and `approvalResetsTimerTest`
  from 4 to 20: `RELAY_PARENT_OFFSET=1` on master AHW advances relay by 4 per block,
  trivially satisfying a delay of 4 on the first `newBlock()`
- Remove strict `expect(current).toBe(target)` assertion from `fullLifecycleTest`;
  relay overshoot is expected and the meaningful assertion is the event
- Flip `controlInheritedAccountProxyFilteredTest` to `controlInheritedAccountNonTransferProxyTest`:
  the PR explicitly allows `control_inherited_account` through `NonTransfer` proxy

* Bump block numbers

* Move recovery tests to westend package

* Add Westend PET package

* Reduce `any` surface in recovery test helpers

Replace `Client<any, any>` with `{ api: ApiPromise }` on helpers that only
need the API. Consolidate all pallet-recovery event data field accesses into a
single `recoveryEventData` extractor, containing the unavoidable cast to one
site with an explanation. Remaining `any` casts are on `api.query.recovery`
and the event predicate — both genuinely unavoidable until pallet-recovery
gains generated TypeScript types in `@polkadot/api`.

* Add some comments to PSM storage in Asset Hub chain file

* Update block numbers

Author: rockbmb

KNOWN_GOOD_BLOCK_NUMBERS_KUSAMA.env

@@ -1,11 +1,11 @@
-ASSETHUBKUSAMA_BLOCK_NUMBER=16320734
-BASILISK_BLOCK_NUMBER=14037168
-BIFROSTKUSAMA_BLOCK_NUMBER=13679100
-BRIDGEHUBKUSAMA_BLOCK_NUMBER=8131570
-CORETIMEKUSAMA_BLOCK_NUMBER=5066739
-ENCOINTERKUSAMA_BLOCK_NUMBER=13497495
-KARURA_BLOCK_NUMBER=11498107
-KUSAMA_BLOCK_NUMBER=33364447
-MOONRIVER_BLOCK_NUMBER=16141016
-PEOPLEKUSAMA_BLOCK_NUMBER=8913298
-SHIDEN_BLOCK_NUMBER=14655667
+ASSETHUBKUSAMA_BLOCK_NUMBER=16399947
+BASILISK_BLOCK_NUMBER=14058899
+BIFROSTKUSAMA_BLOCK_NUMBER=13708373
+BRIDGEHUBKUSAMA_BLOCK_NUMBER=8146157
+CORETIMEKUSAMA_BLOCK_NUMBER=5081409
+ENCOINTERKUSAMA_BLOCK_NUMBER=13523022
+KARURA_BLOCK_NUMBER=11512753
+KUSAMA_BLOCK_NUMBER=33393870
+MOONRIVER_BLOCK_NUMBER=16167319
+PEOPLEKUSAMA_BLOCK_NUMBER=8942534
+SHIDEN_BLOCK_NUMBER=14680186

KNOWN_GOOD_BLOCK_NUMBERS_POLKADOT.env

@@ -1,11 +1,11 @@
-ACALA_BLOCK_NUMBER=11041055
-ASSETHUBPOLKADOT_BLOCK_NUMBER=15290168
-ASTAR_BLOCK_NUMBER=13210525
-BIFROSTPOLKADOT_BLOCK_NUMBER=12100916
-BRIDGEHUBPOLKADOT_BLOCK_NUMBER=7578775
-COLLECTIVESPOLKADOT_BLOCK_NUMBER=8785633
-CORETIMEPOLKADOT_BLOCK_NUMBER=4169586
-HYDRATION_BLOCK_NUMBER=12290624
-MOONBEAM_BLOCK_NUMBER=15476831
-PEOPLEPOLKADOT_BLOCK_NUMBER=4516028
-POLKADOT_BLOCK_NUMBER=31072053
+ACALA_BLOCK_NUMBER=11055889
+ASSETHUBPOLKADOT_BLOCK_NUMBER=15374642
+ASTAR_BLOCK_NUMBER=13233817
+BIFROSTPOLKADOT_BLOCK_NUMBER=12126432
+BRIDGEHUBPOLKADOT_BLOCK_NUMBER=7593633
+COLLECTIVESPOLKADOT_BLOCK_NUMBER=8800504
+CORETIMEPOLKADOT_BLOCK_NUMBER=4184445
+HYDRATION_BLOCK_NUMBER=12312341
+MOONBEAM_BLOCK_NUMBER=15504293
+PEOPLEPOLKADOT_BLOCK_NUMBER=4545218
+POLKADOT_BLOCK_NUMBER=31101915

KNOWN_GOOD_BLOCK_NUMBERS_WESTEND.env

@@ -1 +1 @@
-ASSETHUBWESTEND_BLOCK_NUMBER=14771717
+ASSETHUBWESTEND_BLOCK_NUMBER=14827899

packages/networks/src/chains/assethub.ts

@@ -4,10 +4,6 @@ import { defineChain } from '../defineChain.js'
 import endpoints from '../pet-chain-endpoints.json' with { type: 'json' }
 import { defaultAccounts, defaultAccountsSr25519, testAccounts } from '../testAccounts.js'
 
-/**
- * Build an XCM V5 Location for a local Assets pallet asset.
- * PSM storage and extrinsics now key by `StagingXcmV5Location` instead of raw asset IDs.
- */
 const assetLocation = (assetId: number) => ({
   parents: 0,
   interior: { X2: [{ PalletInstance: 50 }, { GeneralIndex: assetId }] },
@@ -65,21 +61,26 @@ const custom = {
   },
 }
 
-const getPsmInitStorages = (config: typeof custom.assetHubWestend) => {
+const getAhwInitStorages = (config: typeof custom.assetHubWestend) => {
   return {
     System: {
       account: [
         [[defaultAccounts.alice.address], { providers: 1, data: { free: 1000e10 } }],
         [[defaultAccountsSr25519.alice.address], { providers: 1, data: { free: 1000e10 } }],
-        [[testAccounts.alice.address], { providers: 1, data: { free: 1000e10 } }],
-        [[testAccounts.bob.address], { providers: 1, data: { free: 1000e10 } }],
+        // testAccounts funded at 100k WND — enough to cover recovery SecurityDeposit (10 WND) plus fees
+        [[testAccounts.alice.address], { providers: 1, data: { free: 100_000e10 } }],
+        [[testAccounts.bob.address], { providers: 1, data: { free: 100_000e10 } }],
+        [[testAccounts.charlie.address], { providers: 1, data: { free: 100_000e10 } }],
+        [[testAccounts.dave.address], { providers: 1, data: { free: 100_000e10 } }],
+        [[testAccounts.eve.address], { providers: 1, data: { free: 100_000e10 } }],
+        [[testAccounts.ferdie.address], { providers: 1, data: { free: 100_000e10 } }],
       ],
     },
     Assets: {
+      // Synthetic assets injected via Chopsticks override — not present on live WAH
       asset: [
-        // USDX (1338) — synthetic, 2 decimals
         [
-          [config.usdxIndex],
+          [config.usdxIndex], // USDX: 2 decimals, total supply 10,000 USDX
           {
             owner: testAccounts.alice.address,
             issuer: testAccounts.alice.address,
@@ -95,9 +96,8 @@ const getPsmInitStorages = (config: typeof custom.assetHubWestend) => {
             status: 'Live',
           },
         ],
-        // DAI (1339) — synthetic, 18 decimals
         [
-          [config.daiIndex],
+          [config.daiIndex], // DAI: 18 decimals, total supply 10,000 DAI
           {
             owner: testAccounts.alice.address,
             issuer: testAccounts.alice.address,
@@ -122,41 +122,50 @@ const getPsmInitStorages = (config: typeof custom.assetHubWestend) => {
         [[config.daiIndex], { deposit: 0, name: 'Dai Stablecoin', symbol: 'DAI', decimals: 18, isFrozen: false }],
       ],
       account: [
+        // USDT (live on WAH) — alice and bob start with 1,000 USDT each
         [[config.usdtIndex, testAccounts.alice.address], { balance: 1000e6 }],
         [[config.usdtIndex, testAccounts.bob.address], { balance: 1000e6 }],
+        // USDX — alice and bob start with 1,000 USDX each (2 decimals)
         [[config.usdxIndex, testAccounts.alice.address], { balance: 1000 * 100 }],
         [[config.usdxIndex, testAccounts.bob.address], { balance: 1000 * 100 }],
+        // DAI — alice and bob start with 1,000 DAI each (18 decimals)
         [[config.daiIndex, testAccounts.alice.address], { balance: 1000n * 10n ** 18n }],
         [[config.daiIndex, testAccounts.bob.address], { balance: 1000n * 10n ** 18n }],
+        // pUSD stable asset — alice starts with 1,000 pUSD (6 decimals)
         [[config.psmStableAssetId, testAccounts.alice.address], { balance: 1000e6 }],
       ],
     },
     Psm: {
-      maxPsmDebtOfTotal: 500_000,
+      maxPsmDebtOfTotal: 500_000, // 50% of total supply ceiling
+      // registered external assets the PSM will accept for minting/redemption
       externalAssets: [
         [[config.usdtLocation], { AllEnabled: null }],
         [[config.usdxLocation], { AllEnabled: null }],
         [[config.daiLocation], { AllEnabled: null }],
       ],
+      // decimal precision for each external asset — used to normalise amounts
       externalDecimals: [
         [[config.usdtLocation], 6],
         [[config.usdxLocation], 2],
         [[config.daiLocation], 18],
       ],
+      // 0.5% minting fee (5_000 / 1_000_000)
       mintingFee: [
         [[config.usdtLocation], 5_000],
         [[config.usdxLocation], 5_000],
         [[config.daiLocation], 5_000],
       ],
+      // 0.5% redemption fee
       redemptionFee: [
         [[config.usdtLocation], 5_000],
         [[config.usdxLocation], 5_000],
         [[config.daiLocation], 5_000],
       ],
+      // per-asset ceiling as a fraction of maxPsmDebtOfTotal (parts per million)
       assetCeilingWeight: [
-        [[config.usdtLocation], 400_000],
-        [[config.usdxLocation], 300_000],
-        [[config.daiLocation], 300_000],
+        [[config.usdtLocation], 400_000], // 40%
+        [[config.usdxLocation], 300_000], // 30%
+        [[config.daiLocation], 300_000], // 30%
       ],
       psmDebt: [
         [[config.usdtLocation], 0],
@@ -192,50 +201,44 @@ const getInitStorages = (config: typeof custom.assetHubPolkadot | typeof custom.
   return baseStorages
 }
 
+const assetHubProperties = (addressEncoding: number) =>
+  ({
+    addressEncoding,
+    proxyBlockProvider: 'NonLocal',
+    schedulerBlockProvider: 'NonLocal',
+    asyncBacking: 'Enabled',
+    feeExtractor: standardFeeExtractor,
+  }) as const
+
+// Asset Hub Polkadot (SS58: 0)
 export const assetHubPolkadot = defineChain({
   name: 'assetHubPolkadot',
   endpoint: endpoints.assetHubPolkadot,
   paraId: 1000,
   networkGroup: 'polkadot',
   custom: custom.assetHubPolkadot,
   initStorages: getInitStorages(custom.assetHubPolkadot),
-  properties: {
-    addressEncoding: 0,
-    proxyBlockProvider: 'NonLocal',
-    schedulerBlockProvider: 'NonLocal',
-    asyncBacking: 'Enabled',
-    feeExtractor: standardFeeExtractor,
-  },
+  properties: assetHubProperties(0),
 })
 
+// Asset Hub Kusama (SS58: 2)
 export const assetHubKusama = defineChain({
   name: 'assetHubKusama',
   endpoint: endpoints.assetHubKusama,
   paraId: 1000,
   networkGroup: 'kusama',
   custom: custom.assetHubKusama,
   initStorages: getInitStorages(custom.assetHubKusama),
-  properties: {
-    addressEncoding: 2,
-    proxyBlockProvider: 'NonLocal',
-    schedulerBlockProvider: 'NonLocal',
-    asyncBacking: 'Enabled',
-    feeExtractor: standardFeeExtractor,
-  },
+  properties: assetHubProperties(2),
 })
 
+// Asset Hub Westend (SS58: 42) — includes PSM and recovery init storages
 export const assetHubWestend = defineChain({
   name: 'assetHubWestend',
   endpoint: endpoints.assetHubWestend,
   paraId: 1000,
   networkGroup: 'westend',
   custom: custom.assetHubWestend,
-  initStorages: getPsmInitStorages(custom.assetHubWestend),
-  properties: {
-    addressEncoding: 42,
-    proxyBlockProvider: 'NonLocal',
-    schedulerBlockProvider: 'NonLocal',
-    asyncBacking: 'Enabled',
-    feeExtractor: standardFeeExtractor,
-  },
+  initStorages: getAhwInitStorages(custom.assetHubWestend),
+  properties: assetHubProperties(42),
 })

packages/shared/src/index.ts

@@ -14,6 +14,7 @@ export * from './postAhmFiltering.js'
 export * from './preimage.js'
 export * from './proxy.js'
 export * from './psm.js'
+export * from './recovery.js'
 export * from './remoteProxy.js'
 export * from './scheduler.js'
 export * from './setup.js'