fix: outdated integration tests (#632)

Fixes KILTprotocol/ticket#3344.

Integration tests are outdated. Since KILT is now listed on HydraDX, any
tokens sent to the Omnipool account is automatically transferred to the
treasury, which makes the test cases fail. The integration test logic
must be updated to test the following:

1. Send KILT tokens from a KILT account to **its own** sovereign account
on HydraDX (implementation started in this PR for the V2 tests)
2. Send KILT tokens from HydraDX back to KILT (to implement in this PR)

---------

Co-authored-by: Adel Golghalyani <[email protected]>

Author: ntn-x2

.gitlab-ci.yml

@@ -41,8 +41,8 @@ integration-tests:
     - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
     - export NVM_DIR="$HOME/.nvm" && . "$NVM_DIR/nvm.sh" --no-use
     - eval "[ -f .nvmrc ] && nvm install" && nvm use
-    - cargo build -p spiritnet-runtime
     - yarn --immutable
+    - yarn ts-check
     - yarn lint
     - yarn test:CI
 

integration-tests/chopsticks/package.json

@@ -30,9 +30,10 @@
     "eslint-plugin-jsx-a11y": "^6.8.0"
   },
   "scripts": {
+    "ts-check": "tsc --noEmit",
     "lint": "eslint src && prettier --check src",
     "lint:fix": "eslint --fix src && prettier --write src",
-    "clean": "rm -rf ./db && cargo build -p spiritnet-runtime",
+    "clean": "rm -rf ./db",
     "test": "LOG_LEVEL=error vitest",
     "test:CI": "vitest --bail 0  --no-file-parallelism"
   }

integration-tests/chopsticks/src/network/hydraDx.ts

@@ -1,6 +1,5 @@
 import { setupContext, SetupOption } from '@acala-network/chopsticks-testing'
 import type { Config } from './types.js'
-import * as SpiritnetConfig from './spiritnet.js'
 import { initialBalanceHDX, initialBalanceKILT, toNumber } from '../utils.js'
 
 /// Options used to create the HydraDx context
@@ -10,7 +9,7 @@ export const options: SetupOption = {
 	port: toNumber(process.env.HYDRADX_PORT) || 9001,
 }
 
-export const kiltTokenId = 60
+export const kiltTokenId = 28
 
 /// Sets the [TechnicalCommittee] and [Council] governance to the given accounts
 export function setGovernance(addr: string[]) {
@@ -38,38 +37,10 @@ export function assignKiltTokensToAccounts(addr: string[], balance: bigint = ini
 	}
 }
 
-/// Register KILT into HydraDX and allow KILT as payment
-export function registerKilt() {
-	return {
-		assetRegistry: {
-			assetLocations: [[[kiltTokenId], { parents: 1, interior: { X1: { Parachain: SpiritnetConfig.paraId } } }]],
-			assetIds: [[['KILT'], kiltTokenId]],
-			locationAssets: [[[{ parents: 1, interior: { X1: { Parachain: SpiritnetConfig.paraId } } }], kiltTokenId]],
-			assets: [
-				[
-					[kiltTokenId],
-					{
-						name: 'KILT',
-						assetType: 'Token',
-						existentialDeposit: 500,
-						symbol: 'KILT',
-						decimals: 18,
-						xcmRateLimit: null,
-						isSufficient: true,
-					},
-				],
-			],
-		},
-		multiTransactionPayment: {
-			acceptedCurrencies: [[[kiltTokenId], 100_000]],
-		},
-	}
-}
-
 /// HydraDX ParaId
 export const paraId = 2034
 
-/// OmniPool account
+/// Omnipool account
 export const omnipoolAccount = '7L53bUTBbfuj14UpdCNPwmgzzHSsrsTWBHX5pys32mVWM3C1'
 
 export async function getContext(): Promise<Config> {

integration-tests/chopsticks/src/network/spiritnet.ts

@@ -7,9 +7,6 @@ const options: SetupOption = {
 	endpoint: process.env.SPIRITNET_WS || 'wss://kilt-rpc.dwellir.com',
 	db: './db/spiritnet.db.sqlite',
 	port: toNumber(process.env.SPIRITNET_PORT) || 9002,
-	wasmOverride: '../../target/debug/wbuild/spiritnet-runtime/spiritnet_runtime.wasm',
-	// Whether to allow WASM unresolved imports when using a WASM to build the parachain. This Flag is needed otherwise, the runtime can not be built from the WASM. Chopsticks throws an error when it encounters an unresolved import.
-	allowUnresolvedImports: true,
 }
 
 /// Assigns the native tokens to an accounts
@@ -29,15 +26,6 @@ export function setGovernance(addr: string[]) {
 	}
 }
 
-/// Sets the [safeXcmVersion] to the given version
-export function setSafeXcmVersion(version: number) {
-	return {
-		polkadotXcm: {
-			safeXcmVersion: version,
-		},
-	}
-}
-
 /// Spiritnet ParaId
 export const paraId = 2086
 

integration-tests/chopsticks/src/tests/index.ts

@@ -6,7 +6,6 @@ import * as SpiritnetConfig from '../network/spiritnet.js'
 import * as PolkadotConfig from '../network/polkadot.js'
 import * as HydraDxConfig from '../network/hydraDx.js'
 import type { Config } from '../network/types.js'
-import { setStorage } from './utils.js'
 
 export let spiritnetContext: Config
 export let hydradxContext: Config
@@ -18,8 +17,11 @@ beforeAll(async () => {
 	polkadotContext = await PolkadotConfig.getContext()
 
 	// Setup network
+	//@ts-expect-error Something weird in the exported types
 	await connectVertical(polkadotContext.chain, spiritnetContext.chain)
+	//@ts-expect-error Something weird in the exported types
 	await connectVertical(polkadotContext.chain, hydradxContext.chain)
+	//@ts-expect-error Something weird in the exported types
 	await connectParachains([spiritnetContext.chain, hydradxContext.chain])
 
 	const newBlockConfig = { count: 2 }
@@ -31,14 +33,6 @@ beforeAll(async () => {
 		spiritnetContext.dev.newBlock(newBlockConfig),
 		hydradxContext.dev.newBlock(newBlockConfig),
 	])
-
-	console.info('Runtime Upgrade completed')
-
-	// set SafeXcmVersion to 3
-	await setStorage(spiritnetContext, SpiritnetConfig.setSafeXcmVersion(3))
-
-	// register Kilt in HydraDX
-	await setStorage(hydradxContext, HydraDxConfig.registerKilt())
 }, 300_000)
 
 afterAll(async () => {

integration-tests/chopsticks/src/tests/utils.ts

@@ -30,6 +30,18 @@ export async function checkBalance(
 	expect(balance).eq(BigInt(expectedAmount))
 }
 
+/// checks the balance of an account and expects it to be in the given range
+export async function checkBalanceInRange(
+	getFreeBalanceFunction: (account: string) => Promise<bigint>,
+	account: string,
+	expect: ExpectStatic,
+	expectedRange: [bigint, bigint]
+) {
+	const balance = await getFreeBalanceFunction(account)
+	expect(balance >= expectedRange[0])
+	expect(balance <= expectedRange[1])
+}
+
 export function hexAddress(addr: string) {
 	return u8aToHex(decodeAddress(addr))
 }

integration-tests/chopsticks/src/tests/xcm/__snapshots__/limitedReserveTransferSpiritnetHydraDxV2.test.ts.snap

@@ -1,20 +1,29 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx > receiver events currencies 1`] = `
+exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > receiver events currencies 1`] = `
 [
   {
     "data": {
-      "amount": 1000000000000000,
-      "currencyId": 60,
-      "who": "7L53bUTBbfuj14UpdCNPwmgzzHSsrsTWBHX5pys32mVWM3C1",
+      "amount": "(rounded 990000000000000)",
+      "currencyId": 28,
+      "who": "7NL1GYCJu8cFSnWBLwET2X3fMdodw8T75zuxi59hA2bhdjQq",
+    },
+    "method": "Deposited",
+    "section": "currencies",
+  },
+  {
+    "data": {
+      "amount": "(rounded 5000000000000)",
+      "currencyId": 28,
+      "who": "7L53bUTBopuwFt3mKUfmkzgGLayYa1Yvn1hAg9v5UMrQzTfh",
     },
     "method": "Deposited",
     "section": "currencies",
   },
 ]
 `;
 
-exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx > receiver events xcmpQueue 1`] = `
+exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > receiver events xcmpQueue 1`] = `
 [
   {
     "data": {
@@ -31,7 +40,7 @@ exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx >
 ]
 `;
 
-exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx > sender events Balances 1`] = `
+exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > sender events Balances 1`] = `
 [
   {
     "data": {
@@ -44,7 +53,7 @@ exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx >
 ]
 `;
 
-exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx > sender events xcm pallet 1`] = `
+exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > sender events xcm pallet 1`] = `
 [
   {
     "data": {
@@ -61,7 +70,7 @@ exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx >
 ]
 `;
 
-exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx > sender events xcm queue pallet 1`] = `
+exports[`Limited Reserve V2 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > sender events xcm queue pallet 1`] = `
 [
   {
     "data": {

integration-tests/chopsticks/src/tests/xcm/__snapshots__/limitedReserveTransferSpiritnetHydraDxV3.test.ts.snap

@@ -1,20 +1,29 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx > receiver events currencies 1`] = `
+exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > receiver events currencies 1`] = `
 [
   {
     "data": {
-      "amount": 1000000000000000,
-      "currencyId": 60,
-      "who": "7L53bUTBbfuj14UpdCNPwmgzzHSsrsTWBHX5pys32mVWM3C1",
+      "amount": "(rounded 990000000000000)",
+      "currencyId": 28,
+      "who": "7NL1GYCJu8cFSnWBLwET2X3fMdodw8T75zuxi59hA2bhdjQq",
+    },
+    "method": "Deposited",
+    "section": "currencies",
+  },
+  {
+    "data": {
+      "amount": "(rounded 5000000000000)",
+      "currencyId": 28,
+      "who": "7L53bUTBopuwFt3mKUfmkzgGLayYa1Yvn1hAg9v5UMrQzTfh",
     },
     "method": "Deposited",
     "section": "currencies",
   },
 ]
 `;
 
-exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx > receiver events xcmpQueue 1`] = `
+exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > receiver events xcmpQueue 1`] = `
 [
   {
     "data": {
@@ -31,7 +40,7 @@ exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx >
 ]
 `;
 
-exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx > sender events Balances 1`] = `
+exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > sender events Balances 1`] = `
 [
   {
     "data": {
@@ -44,7 +53,7 @@ exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx >
 ]
 `;
 
-exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx > sender events xcm pallet 1`] = `
+exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > sender events xcm pallet 1`] = `
 [
   {
     "data": {
@@ -61,7 +70,7 @@ exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx >
 ]
 `;
 
-exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx > sender events xcm queue pallet 1`] = `
+exports[`Limited Reserve V3 Transfers from Spiritnet Account Alice -> HydraDx Account Alice > sender events xcm queue pallet 1`] = `
 [
   {
     "data": {

integration-tests/chopsticks/src/tests/xcm/__snapshots__/limitedReseveTransferHydraDxSpiritnet.test.ts.snap

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > receiver events Balances 1`] = `
+exports[`Limited Reserve Transfers from HydraDx Account Alice -> Spiritnet Account Alice > receiver events Balances 1`] = `
 [
   {
     "data": {
@@ -13,7 +13,7 @@ exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > recei
 ]
 `;
 
-exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > receiver events Balances 2`] = `
+exports[`Limited Reserve Transfers from HydraDx Account Alice -> Spiritnet Account Alice > receiver events Balances 2`] = `
 [
   {
     "data": {
@@ -26,7 +26,7 @@ exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > recei
 ]
 `;
 
-exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > receiver events xcmpQueue 1`] = `
+exports[`Limited Reserve Transfers from HydraDx Account Alice -> Spiritnet Account Alice > receiver events xcmpQueue 1`] = `
 [
   {
     "data": {
@@ -43,30 +43,30 @@ exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > recei
 ]
 `;
 
-exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > sender events currencies 1`] = `
+exports[`Limited Reserve Transfers from HydraDx Account Alice -> Spiritnet Account Alice > sender events currencies 1`] = `
 [
   {
     "data": {
       "amount": "(rounded 440000000000)",
       "currencyId": 0,
-      "who": "7MZG43idRmdg8VSt5BS9mVJeBhhxxt5y55hCsMpoKp5xFQX2",
+      "who": "7NL1GYCJu8cFSnWBLwET2X3fMdodw8T75zuxi59hA2bhdjQq",
     },
     "method": "Withdrawn",
     "section": "currencies",
   },
   {
     "data": {
       "amount": 1000000000000000,
-      "currencyId": 60,
-      "who": "7MZG43idRmdg8VSt5BS9mVJeBhhxxt5y55hCsMpoKp5xFQX2",
+      "currencyId": 28,
+      "who": "7NL1GYCJu8cFSnWBLwET2X3fMdodw8T75zuxi59hA2bhdjQq",
     },
     "method": "Withdrawn",
     "section": "currencies",
   },
 ]
 `;
 
-exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > sender events currencies 2`] = `
+exports[`Limited Reserve Transfers from HydraDx Account Alice -> Spiritnet Account Alice > sender events currencies 2`] = `
 [
   {
     "data": {
@@ -118,15 +118,15 @@ exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > sende
           },
         },
       },
-      "sender": "7MZG43idRmdg8VSt5BS9mVJeBhhxxt5y55hCsMpoKp5xFQX2",
+      "sender": "7NL1GYCJu8cFSnWBLwET2X3fMdodw8T75zuxi59hA2bhdjQq",
     },
     "method": "TransferredMultiAssets",
     "section": "xTokens",
   },
 ]
 `;
 
-exports[`Limited Reserve Transfers from HydraDx Account Bob -> Spiritnet > sender events xcm queue pallet 1`] = `
+exports[`Limited Reserve Transfers from HydraDx Account Alice -> Spiritnet Account Alice > sender events xcm queue pallet 1`] = `
 [
   {
     "data": {