chore: integration tests chopsticks

.gitignore

@@ -20,3 +20,5 @@
 **/node_modules
 
 runtimes/spiritnet/src/xcm_tests/e2e/out
+
+*.db.sqlite*

.gitlab-ci.yml

@@ -10,7 +10,7 @@ clippy-and-docs:
     - cargo clippy --all-features --all-targets --locked -- -D warnings
     - RUSTDOCFLAGS='-D warnings' cargo doc --all-features --no-deps --locked
 
-fmt:
+fmt-rust:
   image: paritytech/ci-unified:bullseye-1.70.0
   stage: test
   script:
@@ -30,6 +30,19 @@ test-features:
   script:
     - cargo test --all --all-features --all-targets --locked
 
+integration-tests:
+  timeout: 15 minutes
+  image: paritytech/ci-unified:bullseye-1.70.0
+  stage: test
+  script:
+    - cd ./integration-tests/chopsticks
+    - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+    - nvm install
+    - cargo build -p spiritnet-runtime
+    - yarn --immutable
+    - yarn lint
+    - yarn test
+
 # TODO: The try-runtime-cli executable could be built as part of the Docker image directly, saving some time.
 test-try-runtime:
   parallel:

integration-tests/chopsticks/.env-example

@@ -0,0 +1,6 @@
+HYDRADX_WS=
+HYDRADX_PORT=
+POLKADOT_WS=
+POLKADOT_PORT=
+SPIRITNET_WS=
+SPIRITNET_PORT=

integration-tests/chopsticks/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "project": "./tsconfig.json"
+  },
+  "plugins": ["@typescript-eslint", "prettier"],
+  "rules": {
+    "quotes": ["warn", "single"]
+  }
+}

integration-tests/chopsticks/.nvmrc

@@ -0,0 +1 @@
+v20.11.0

integration-tests/chopsticks/.prettierrc

@@ -0,0 +1 @@
+{ "singleQuote": true, "trailingComma": "es5", "semi": false }

integration-tests/chopsticks/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@kiltprotocol/e2e-tests",
+  "version": "0.0.1",
+  "description": "chopsticks integration tests",
+  "private": "true",
+  "type": "module",
+  "repository": "git@github.com:KILTprotocol/kilt-node.git",
+  "author": "[\"KILT <info@kilt.io>\"]",
+  "license": "MIT",
+  "devDependencies": {
+    "@acala-network/chopsticks": "0.10.0",
+    "@acala-network/chopsticks-testing": "0.10.0",
+    "@polkadot/api": "^10.11.2",
+    "@types/node": "^20.11.30",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
+    "eslint": "^8.0.1",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard-with-typescript": "^43.0.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0 || ^16.0.0 ",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-promise": "^6.0.0",
+    "prettier": "^3.2.5",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.7.1",
+    "typescript": "*",
+    "vitest": "^1.4.0",
+    "eslint-plugin-jsx-a11y": "^6.8.0"
+  },
+  "scripts": {
+    "lint": "eslint src && prettier --check src",
+    "lint:fix": "eslint --fix src && prettier --write src",
+    "clean": "rm -rf ./db && cargo build -p spiritnet-runtime",
+    "test": "LOG_LEVEL=error vitest --testTimeout=5000 --isolate=true"
+  }
+}

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

@@ -0,0 +1,77 @@
+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
+export const options: SetupOption = {
+	endpoint: process.env.HYDRADX_WS || ['wss://hydradx-rpc.dwellir.com', 'wss://rpc.hydradx.cloud'],
+	db: './db/hydradx.db.sqlite',
+	port: toNumber(process.env.HYDRADX_PORT) || 9001,
+}
+
+export const kiltTokenId = 60
+
+/// Sets the [TechnicalCommittee] and [Council] governance to the given accounts
+export function setGovernance(addr: string[]) {
+	return {
+		TechnicalCommittee: { Members: addr },
+		Council: { Members: addr },
+	}
+}
+
+/// Assigns the native tokens to an accounts
+export function assignNativeTokensToAccounts(addr: string[], balance: bigint = initialBalanceHDX) {
+	return {
+		System: {
+			Account: addr.map((address) => [[address], { providers: 1, data: { free: balance } }]),
+		},
+	}
+}
+
+/// Assigns KILT tokens to an accounts
+export function assignKiltTokensToAccounts(addr: string[], balance: bigint = initialBalanceKILT) {
+	return {
+		Tokens: {
+			Accounts: addr.map((address) => [[address, kiltTokenId], { free: balance }]),
+		},
+	}
+}
+
+/// 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
+export const omnipoolAccount = '7L53bUTBbfuj14UpdCNPwmgzzHSsrsTWBHX5pys32mVWM3C1'
+
+export async function getContext(): Promise<Config> {
+	return setupContext(options)
+}

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

@@ -0,0 +1,40 @@
+import { setupContext, SetupOption } from '@acala-network/chopsticks-testing'
+import type { Config } from './types.js'
+import { initialBalanceDOT, toNumber } from '../utils.js'
+
+/// Options used to create the HydraDx context
+export const options: SetupOption = {
+	endpoint: process.env.POLKADOT_WS || [
+		'wss://rpc.polkadot.io',
+		'wss://polkadot-rpc.dwellir.com',
+		'wss://rpc.ibp.network/polkadot',
+	],
+	db: './db/polkadot.db.sqlite',
+	port: toNumber(process.env.POLKADOT_PORT) || 9000,
+}
+
+/// Assigns the native tokens to an accounts
+export function assignNativeTokensToAccounts(addr: string[], balance: bigint = initialBalanceDOT) {
+	return {
+		System: {
+			Account: addr.map((address) => [[address], { providers: 1, data: { free: balance } }]),
+		},
+	}
+}
+
+export function removeDisputesAndMessageQueues() {
+	return {
+		ParasDisputes: {
+			// those can makes block building super slow
+			$removePrefix: ['disputes'],
+		},
+		Dmp: {
+			// clear existing dmp to avoid impact test result
+			$removePrefix: ['downwardMessageQueues'],
+		},
+	}
+}
+
+export async function getContext(): Promise<Config> {
+	return setupContext(options)
+}

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

@@ -0,0 +1,50 @@
+import { setupContext, SetupOption } from '@acala-network/chopsticks-testing'
+import type { Config } from './types.js'
+import { initialBalanceKILT, toNumber } from '../utils.js'
+
+/// Options used to create the Spiritnet context
+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
+export function assignNativeTokensToAccounts(addr: string[], balance: bigint = initialBalanceKILT) {
+	return {
+		System: {
+			Account: addr.map((address) => [[address], { providers: 1, data: { free: balance } }]),
+		},
+	}
+}
+
+/// Sets the [technicalCommittee] and [council] governance to the given accounts
+export function setGovernance(addr: string[]) {
+	return {
+		technicalCommittee: { Members: addr },
+		council: { Members: addr },
+	}
+}
+
+/// Sets the [safeXcmVersion] to the given version
+export function setSafeXcmVersion(version: number) {
+	return {
+		polkadotXcm: {
+			safeXcmVersion: version,
+		},
+	}
+}
+
+/// Spiritnet ParaId
+export const paraId = 2086
+
+/// The sovereign account of HydraDx in Spiritnet
+export const hydraDxSovereignAccount = '4qXPdpioJ6D8cgdeYXaukV2Y2oAQUHaX1VnGhdbSRqJn2CBt'
+
+/// Returns the Spiritnet context for the given options
+export async function getContext(): Promise<Config> {
+	return setupContext(options)
+}

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

@@ -0,0 +1,3 @@
+import type { setupContext } from '@acala-network/chopsticks-testing'
+
+export type Config = Awaited<ReturnType<typeof setupContext>>

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

@@ -0,0 +1,53 @@
+export function getSiblingLocation(paraId: number) {
+	return {
+		parents: 1,
+		interior: {
+			X1: { Parachain: paraId },
+		},
+	}
+}
+
+export function getParentLocation() {
+	return {
+		parents: 1,
+		interior: 'Here',
+	}
+}
+
+export function getAccountLocationV2(addr: string) {
+	return {
+		V2: {
+			parents: 0,
+			interior: {
+				X1: {
+					AccountId32: {
+						network: 'Any',
+						id: addr,
+					},
+				},
+			},
+		},
+	}
+}
+
+export function getAccountLocationV3(addr: string) {
+	return {
+		V3: {
+			parents: 0,
+			interior: {
+				X1: {
+					AccountId32: {
+						id: addr,
+					},
+				},
+			},
+		},
+	}
+}
+
+export function getNativeAssetIdLocation(amount: bigint) {
+	return {
+		id: { Concrete: { parents: 0, interior: 'Here' } },
+		fun: { Fungible: amount },
+	}
+}

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

@@ -0,0 +1,59 @@
+import { beforeAll, afterAll } from 'vitest'
+import { connectParachains, connectVertical } from '@acala-network/chopsticks'
+import { setTimeout } from 'timers/promises'
+
+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
+export let polkadotContext: Config
+
+beforeAll(async () => {
+	spiritnetContext = await SpiritnetConfig.getContext()
+	hydradxContext = await HydraDxConfig.getContext()
+	polkadotContext = await PolkadotConfig.getContext()
+
+	// Setup network
+	await connectVertical(polkadotContext.chain, spiritnetContext.chain)
+	await connectVertical(polkadotContext.chain, hydradxContext.chain)
+	await connectParachains([spiritnetContext.chain, hydradxContext.chain])
+
+	const newBlockConfig = { count: 2 }
+	// fixes api runtime disconnect warning
+	await setTimeout(50)
+	// Perform runtime upgrade and establish xcm connections.
+	await Promise.all([
+		polkadotContext.dev.newBlock(newBlockConfig),
+		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())
+}, 60_000)
+
+afterAll(async () => {
+	// fixes api runtime disconnect warning
+	await setTimeout(50)
+	await Promise.all([spiritnetContext.teardown(), hydradxContext.teardown(), polkadotContext.teardown()])
+})
+
+export async function getFreeBalanceSpiritnet(account: string): Promise<bigint> {
+	const accountInfo = await spiritnetContext.api.query.system.account(account)
+	return accountInfo.data.free.toBigInt()
+}
+
+export async function getFreeBalanceHydraDxKilt(account: string): Promise<bigint> {
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	const accountInfo: any = await hydradxContext.api.query.tokens.accounts(account, HydraDxConfig.kiltTokenId)
+	return accountInfo.free.toBigInt()
+}