@acala-network/chopsticks-testing 0.7.0 → 0.7.1

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import { ApiPromise, WsProvider } from '@polkadot/api';
 import { Codec } from '@polkadot/types/types';
+import { Config } from '@acala-network/chopsticks/schema';
 import { HexString } from '@polkadot/util/types';
 import { Keyring } from '@polkadot/keyring';
 import { StorageValues } from '@acala-network/chopsticks/utils/set-storage';
@@ -12,8 +13,13 @@ export type SetupOption = {
     wasmOverride?: string;
     db?: string;
     timeout?: number;
+    port?: number;
 };
-export declare const setupContext: ({ endpoint, blockNumber, blockHash, wasmOverride, db, timeout }: SetupOption) => Promise<{
+export type SetupConfig = Config & {
+    timeout?: number;
+};
+export declare const createConfig: ({ endpoint, blockNumber, blockHash, wasmOverride, db, timeout, port, }: SetupOption) => SetupConfig;
+export declare const setupContext: (option: SetupOption) => Promise<{
     url: string;
     chain: import("@acala-network/chopsticks").Blockchain;
     ws: WsProvider;
@@ -30,6 +36,41 @@ export declare const setupContext: ({ endpoint, blockNumber, blockHash, wasmOver
     teardown(): Promise<void>;
     pause(): Promise<unknown>;
 }>;
+export declare const setupContextWithConfig: ({ timeout, ...config }: SetupConfig) => Promise<{
+    url: string;
+    chain: import("@acala-network/chopsticks").Blockchain;
+    ws: WsProvider;
+    api: ApiPromise;
+    dev: {
+        newBlock: (param?: {
+            count?: number;
+            to?: number;
+        }) => Promise<string>;
+        setStorage: (values: StorageValues, blockHash?: string) => Promise<any>;
+        timeTravel: (date: string | number) => Promise<number>;
+        setHead: (hashOrNumber: string | number) => Promise<any>;
+    };
+    teardown(): Promise<void>;
+    pause(): Promise<unknown>;
+}>;
+export type NetworkContext = Awaited<ReturnType<typeof setupContext>>;
+export declare const setupNetworks: (networkOptions: Partial<Record<string, Config | string | undefined>>) => Promise<Record<string, {
+    url: string;
+    chain: import("@acala-network/chopsticks").Blockchain;
+    ws: WsProvider;
+    api: ApiPromise;
+    dev: {
+        newBlock: (param?: {
+            count?: number;
+            to?: number;
+        }) => Promise<string>;
+        setStorage: (values: StorageValues, blockHash?: string) => Promise<any>;
+        timeTravel: (date: string | number) => Promise<number>;
+        setHead: (hashOrNumber: string | number) => Promise<any>;
+    };
+    teardown(): Promise<void>;
+    pause(): Promise<unknown>;
+}>>;
 type CodecOrArray = Codec | Codec[];
 export declare const expectJson: (codec: CodecOrArray) => import("@vitest/expect").Assertion<any>;
 export declare const expectHex: (codec: CodecOrArray) => import("@vitest/expect").Assertion<any>;

package/lib/index.js

@@ -1,11 +1,11 @@
 import { ApiPromise, WsProvider } from '@polkadot/api';
-import { BuildBlockMode, setupWithServer } from '@acala-network/chopsticks';
+import { BuildBlockMode, connectParachains, connectVertical, fetchConfig, setupWithServer, } from '@acala-network/chopsticks';
 import { Keyring, createTestKeyring } from '@polkadot/keyring';
 import { expect } from 'vitest';
 export * from './check';
-export const setupContext = async ({ endpoint, blockNumber, blockHash, wasmOverride, db, timeout }) => {
-    // random port
-    const port = Math.floor(Math.random() * 10000) + 10000;
+export const createConfig = ({ endpoint, blockNumber, blockHash, wasmOverride, db, timeout, port, }) => {
+    // random port if not specified
+    port = port ?? Math.floor(Math.random() * 10000) + 10000;
     const config = {
         endpoint,
         port,
@@ -14,7 +14,14 @@ export const setupContext = async ({ endpoint, blockNumber, blockHash, wasmOverr
         'build-block-mode': BuildBlockMode.Manual,
         db,
         'wasm-override': wasmOverride,
+        timeout,
     };
+    return config;
+};
+export const setupContext = async (option) => {
+    return setupContextWithConfig(createConfig(option));
+};
+export const setupContextWithConfig = async ({ timeout, ...config }) => {
     const { chain, listenPort, close } = await setupWithServer(config);
     const url = `ws://localhost:${listenPort}`;
     const ws = new WsProvider(url, undefined, undefined, timeout);
@@ -59,6 +66,37 @@ export const setupContext = async ({ endpoint, blockNumber, blockHash, wasmOverr
         },
     };
 };
+export const setupNetworks = async (networkOptions) => {
+    const ret = {};
+    let wasmOverriden = false;
+    for (const [name, options] of Object.entries(networkOptions)) {
+        const config = typeof options === 'string' ? await fetchConfig(options) : options ?? (await fetchConfig(name));
+        ret[name] = await setupContextWithConfig(config);
+        wasmOverriden ||= config['wasm-override'] != null;
+    }
+    const relaychainName = Object.keys(ret).filter((x) => ['polkadot', 'kusama'].includes(x.toLocaleLowerCase()))[0];
+    const { [relaychainName]: relaychain, ...parachains } = ret;
+    if (relaychain) {
+        for (const parachain of Object.values(parachains)) {
+            await connectVertical(relaychain.chain, parachain.chain);
+        }
+    }
+    const parachainList = Object.values(parachains).map((i) => i.chain);
+    if (parachainList.length > 0) {
+        await connectParachains(parachainList);
+    }
+    if (wasmOverriden) {
+        // trigger runtime upgrade if needed (due to wasm override)
+        for (const chain of Object.values(ret)) {
+            await chain.dev.newBlock();
+        }
+        // handle xcm version message if needed (due to wasm override triggered xcm version upgrade)
+        for (const chain of Object.values(ret)) {
+            await chain.dev.newBlock();
+        }
+    }
+    return ret;
+};
 const processCodecOrArray = (codec, fn) => Array.isArray(codec) ? codec.map(fn) : fn(codec);
 const toHuman = (codec) => processCodecOrArray(codec, (c) => c?.toHuman?.() ?? c);
 const toJson = (codec) => processCodecOrArray(codec, (c) => c?.toJSON?.() ?? c);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acala-network/chopsticks-testing",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "author": "Bryan Chen <xlchen1291@gmail.com>",
   "license": "Apache-2.0",
   "scripts": {
@@ -8,7 +8,7 @@
     "build": "tsc -p ./tsconfig.json"
   },
   "dependencies": {
-    "@acala-network/chopsticks": "0.7.0"
+    "@acala-network/chopsticks": "0.7.1"
   },
   "peerDependencies": {
     "vitest": "^0.33.0"