Create E2E test suite for accounts and balances (#377)

* Init balances e2e tests (wip)

* Rework initial tests for clarity

Most of them were written with recourse to Cursor, and were just not
very useful.

* Refactor `transfer_allow_death` test

It scrutinizes the extrinsic's events and their inner data.

* Recreate tests for all Polkadot/Kusama relay/SPs

* Rework networks that run `transferAllowDeath` test

Now, at the calling site of the test tree creation function, chains can
signal whether their ED is too low to run the basic `transferAllowDeath`
test.

* Scrutinize more events in `transferAllowDeath` test

* Test non-destructive `transfer_allow_death`

* Test `force_transfer` with account reaping

* Test to `force_transfer` reaping

* Test `transfer_allow_death` below ED

* Test `force_transfer` below ED

* Test overtransferring account

* Update comments and snapshots

* Test `force_transfer` with insufficient funds

* Test self `transfer_allow_death` of near-entire balance

* Update snapshots

* Update accounts tests after merge from `master`

PR #384 required some additional fixes that auto-merge could not perform.

* Update snapshots

* Fund new test account on Bridge Hub

* Revert change to Polkadot AH multisig suite name

* Create test to liquidity restrictions bug

See paritytech/polkadot-sdk#9560 and
paritytech/polkadot-sdk#8108.

TL;DR proxy and multisig pallets are using the old `Currency` trait
and not the new fungible traits, it is possible for an operation that
is permissible to an account at a given point in time and state to
fail.

See #401

* Test liquidity restrictions when creating proxy

* Parametrize deposit-requiring action liquidity restriction test

The `balances.LiquidityRestrictions` error can occur is different
contexts, as multiple pallets still use the old `Currency::reserve`
operation.

This commit parametrizes the test to allow for different kinds of
actions to be tested, not just proxy addition.

* Extend liquidity restriction tests to cover more cases

The test now combinatorially covers several cases:
1. Reserve action can vary between staking bond and nomination pool creation
2. Lock action is always vested transfer (for now)
3. Deposit action can vary between proxy creation, referendum submission
   and staking bond

* Test manual reserve/lock in liquidity restriction tests

This adds the possibility of manually set reserve/locks to the reserve/
lock actions used to combinatorially generate tests to liquidity
restrictions.

This is needed because some chains have no vesting or staking, but the
behavior should still be tested.

* Fix manual reserve/lock actions in liq. restriction tests

Fees were not being accounted for correctly when performing checks
on free/frozen balances.

* Update snapshots and accounts E2E test tree call sites

* Filter vesting as locking action on Asset Hubs

... while the AHM is pending - vesting operations are filtered, and
thus cannot be used.

* Add more comments to liquidity restriction test

Especially the action interfaces.

* Add more comments to liquidity restriction tests

* Remove leftover debug code from self-transfer test

* Fix Asset Hub test suites' use of relay chain

An invalid argument was being passed to the `scheduleInlineCallWithOrigin`
function: the base's chains block provider, instead of the relay chain's,
which is always `Local`.

* Snapshot skipped liquidity restriction tests

... instead of logging a message. Logs add some noise to CI test output.

* Apply lint fixes

* Update block numbers

* Change lock identifier used

* Remove unstable `Transfer` event from snapshots

* Update snapshots

* Simplify liquidity restriction tests

The `Balance.locks` storage is no longer modified - Polkadot Relay is
failing for an undetermined reason.

* Use nonces when setting storage

* Test `transfer_allow_death` with reserve

* Add test to `transfer_all` with reserve

* Add `force_transfer` with reserve test

* Add origin check tests for gated extrinsics

* Add tests to transfer functions with insufficient funds

* Test `transfer_all` with `keepAlive = true`

* Correct previous transfer all test snapshot

* Test `transfer_all` with `keep_alive = false`

* Correct snapshots of accounts tests

* Test `transfer_keep_alive` with source left below ED

* Split `transfer_keep_alive` tests

... into two separate tests:
1. one for chains with low ED (below a typical transfer fee)
2. one for chains with normal ED

* Test `force_adjust_total_issuance` with zero delta

* Test total issuance changes

* Test `force_unreserve` no-op cases

* Update accounts E2E test snapshots

* Update liquidity restriction test snapshots for AHs

* Test forceful unreservation of funds

* Add more self-transfer tests

* Add self-transfer test to `force_transfer`

* Add tests to `force_set_balance`

* Refactor `burn` tests into low/normal ED tests

* Update snapshots with new `burn` tests

* Test burning from account with consumer reference

* Add test to burning of entire balance (or more than it)

* Update snapshots to remove obsolete data

* Improve documentation and `README`

Author: rockbmb

README.md

@@ -83,12 +83,31 @@ LOG_LEVEL=info             # General logging (error/warn/info/debug/trace)
 This repository contains E2E tests for the Polkadot/Kusama networks.
 
 These include:
+- E2E suite for accounts and currency-related operations:
+  - tests for transfer functions: `transfer_allow_death`, `transfer_keep_alive`, `transfer_all`
+      - these tests include scenarios for successful transfers, transfers from accounts with insufficient funds,
+        transfers of values below ED, account reaping, and self-transfers
+  - tests for privileged functions: `force_transfer`, `force_unreserve`, `force_set_balance`, `force_adjust_total_issuance`
+      - these include cover both successful operations and insufficient priviledge failures
+      - in the case of `force_transfer`, they include cases similar to those of signed transfer operations
+      - `force_set_balance` tests include reaping checks when a balance below the chain's ED is set
+  - tests to `burn` check the proper modification of total issuance, as well as burns that can cause reaping
+  - tests to liquidity restrictions arising from the mixing of `Currency` and `Fungible` traits
+      - these tests combinatorially generate accounts with reserves and freezes from pallets that use the new `Fungible`
+      trait, and then attempts to create a reserve with an operation using the deprecated `Currency::reserve` functions.
+      - these tests currently expect the operation to fail, but will gradually start passing as networks' runtimes are
+      upgraded
+      - the actions used to trigger this bug are `proxy::add_proxy`, `multisig::as_multi`, and `referenda::submit`, althout
+        any pallet using `Currency::reserve` is at risk
+      - see https://github.com/paritytech/polkadot-sdk/pull/8108, and https://github.com/paritytech/polkadot-sdk/pull/9560/
+        for the fixes
 - E2E suite for proxy accounts:
   - proxy account creation, removal
   - pure proxy account creation, removal
   - execution of proxy calls
   - test delay in proxy actions, as well as announcement/removal, and executing of announced action
-  - proxy call filtering works both positively and negatively; in particular, for every proxy type in Polkadot/Kusama relay and system parachains, it is checked that:
+  - proxy call filtering works both positively and negatively; in particular, for every proxy type in Polkadot/Kusama
+    relay and system parachains, it is checked that:
       - a proxy of a given type can always execute calls which that proxy type is allowed to execute
       - a proxy of a given type can never execute calls that its proxy type disallowws it from running
         - see the section below for more

packages/kusama/src/__snapshots__/assetHubKusama.accounts.e2e.test.ts.snap

@@ -0,0 +1,244 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Kusama Asset Hub Accounts > \`burn\` > burning funds from account works > events when Alice self-burns funds 1`] = `
+[
+  {
+    "data": {
+      "amount": "(rounded 1700000000)",
+      "who": "D8ew585BL5H1ALhn4kmJoxhgqcgKDZLPc6xunJNv4mmrBns",
+    },
+    "method": "Burned",
+    "section": "balances",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > \`force_adjust_total_issuance\` > successful adjustments increase and decrease total issuance > events for first issuance change 1`] = `
+[
+  {
+    "data": {
+      "new_": "(rounded 160000000000000000)",
+      "old": "(rounded 160000000000000000)",
+    },
+    "method": "TotalIssuanceForced",
+    "section": "balances",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > \`force_adjust_total_issuance\` > successful adjustments increase and decrease total issuance > events for second issuance change 1`] = `
+[
+  {
+    "data": {
+      "new_": "(rounded 160000000000000000)",
+      "old": "(rounded 160000000000000000)",
+    },
+    "method": "TotalIssuanceForced",
+    "section": "balances",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > \`force_transfer\` > force transferring origin below ED can kill it > events of \`force_transfer\` from Alice to Bob 1`] = `
+[
+  {
+    "data": {
+      "account": "D8ew585BL5H1ALhn4kmJoxhgqcgKDZLPc6xunJNv4mmrBns",
+    },
+    "method": "KilledAccount",
+    "section": "system",
+  },
+  {
+    "data": {
+      "account": "D8ew585BL5H1ALhn4kmJoxhgqcgKDZLPc6xunJNv4mmrBns",
+      "amount": "(rounded 1100000)",
+    },
+    "method": "DustLost",
+    "section": "balances",
+  },
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+    },
+    "method": "NewAccount",
+    "section": "system",
+  },
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+      "freeBalance": "(rounded 3300000)",
+    },
+    "method": "Endowed",
+    "section": "balances",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > \`transfer_all\` > account with reserves cannot transfer all funds > events when Alice with reserve transfers all to Bob 1`] = `
+[
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+    },
+    "method": "NewAccount",
+    "section": "system",
+  },
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+      "freeBalance": "(rounded 170000000)",
+    },
+    "method": "Endowed",
+    "section": "balances",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > \`transfer_all\` > transfer all with keepAlive false kills sender > events when Alice transfers all to Bob with \`keepAlive = false\` 1`] = `
+[
+  {
+    "data": {
+      "account": "D8ew585BL5H1ALhn4kmJoxhgqcgKDZLPc6xunJNv4mmrBns",
+    },
+    "method": "KilledAccount",
+    "section": "system",
+  },
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+    },
+    "method": "NewAccount",
+    "section": "system",
+  },
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+      "freeBalance": "(rounded 240000000)",
+    },
+    "method": "Endowed",
+    "section": "balances",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > \`transfer_all\` > transfer all with keepAlive true leaves 1 ED > events when Alice transfers all to Bob with \`keepAlive = true\` 1`] = `
+[
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+    },
+    "method": "NewAccount",
+    "section": "system",
+  },
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+      "freeBalance": "(rounded 230000000)",
+    },
+    "method": "Endowed",
+    "section": "balances",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via manual reserve and manual lock, triggered via multisig creation > liquidity restricted action events 1`] = `
+[
+  {
+    "data": {
+      "dispatchError": {
+        "Module": {
+          "error": "0x01000000",
+          "index": 10,
+        },
+      },
+      "dispatchInfo": {
+        "class": "Normal",
+        "paysFee": "Yes",
+        "weight": {
+          "proofSize": "(rounded 20000)",
+          "refTime": "(rounded 900000000)",
+        },
+      },
+    },
+    "method": "ExtrinsicFailed",
+    "section": "system",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via manual reserve and manual lock, triggered via proxy addition > liquidity restricted action events 1`] = `
+[
+  {
+    "data": {
+      "dispatchError": {
+        "Module": {
+          "error": "0x01000000",
+          "index": 10,
+        },
+      },
+      "dispatchInfo": {
+        "class": "Normal",
+        "paysFee": "Yes",
+        "weight": {
+          "proofSize": "(rounded 10000)",
+          "refTime": "(rounded 800000000)",
+        },
+      },
+    },
+    "method": "ExtrinsicFailed",
+    "section": "system",
+  },
+]
+`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via manual reserve and manual lock, triggered via referendum submission > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: deposit=referendum submission"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via manual reserve and vested transfer, triggered via multisig creation > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: lock=vested transfer"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via manual reserve and vested transfer, triggered via proxy addition > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: lock=vested transfer"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via manual reserve and vested transfer, triggered via referendum submission > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: lock=vested transfer, deposit=referendum submission"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via nomination pool and manual lock, triggered via multisig creation > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=nomination pool"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via nomination pool and manual lock, triggered via proxy addition > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=nomination pool"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via nomination pool and manual lock, triggered via referendum submission > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=nomination pool, deposit=referendum submission"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via nomination pool and vested transfer, triggered via multisig creation > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=nomination pool, lock=vested transfer"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via nomination pool and vested transfer, triggered via proxy addition > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=nomination pool, lock=vested transfer"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via nomination pool and vested transfer, triggered via referendum submission > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=nomination pool, lock=vested transfer, deposit=referendum submission"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via staking bond and manual lock, triggered via multisig creation > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=staking bond"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via staking bond and manual lock, triggered via proxy addition > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=staking bond"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via staking bond and manual lock, triggered via referendum submission > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=staking bond, deposit=referendum submission"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via staking bond and vested transfer, triggered via multisig creation > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=staking bond, lock=vested transfer"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via staking bond and vested transfer, triggered via proxy addition > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=staking bond, lock=vested transfer"`;
+
+exports[`Kusama Asset Hub Accounts > currency tests > liquidity restriction error: funds locked via staking bond and vested transfer, triggered via referendum submission > liquidity restriction test skipped 1`] = `"Skipping test - required pallets not available: reserve=staking bond, lock=vested transfer, deposit=referendum submission"`;
+
+exports[`Kusama Asset Hub Accounts > transfer_allow_death > transfer of some funds does not kill sender account > events when Alice transfers 1 ED to Bob with sufficient balance 1`] = `
+[
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+    },
+    "method": "NewAccount",
+    "section": "system",
+  },
+  {
+    "data": {
+      "account": "EvvS4HELEC1nxVHsjYUsPvypd2kXeu78AguyiSN7kV2pTnk",
+      "freeBalance": "(rounded 3300000)",
+    },
+    "method": "Endowed",
+    "section": "balances",
+  },
+]
+`;