chore: e2e tests setup via ink node & contracts node (#271)

* add e2e tests setup

* fix path

* move tests

Author: sinzii

.github/workflows/create-typink-template-tests.yml

@@ -2,8 +2,10 @@ name: Create-Typink Template Tests
 
 on:
   push:
+    branches: [ main ]
   workflow_dispatch:
   merge_group:
+  pull_request:
 
 env:
   TYPINK_TEMPLATE_BRANCH: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref_name }}

.github/workflows/demo-build-tests.yml

@@ -5,8 +5,10 @@ name: Demo Build Tests
 
 on:
   push:
+    branches: [ main ]
   workflow_dispatch:
   merge_group:
+  pull_request:
 
 jobs:
   unit-tests:

.github/workflows/e2e-tests.yml

@@ -0,0 +1,51 @@
+name: E2E Tests
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+  merge_group:
+  pull_request:
+
+jobs:
+  e2e-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn install --immutable
+      - run: yarn build
+      - name: Download executables
+        run: |
+          curl -L -O https://github.com/paritytech/substrate-contracts-node/releases/download/v0.42.0/substrate-contracts-node-linux.tar.gz 
+          tar -xzf substrate-contracts-node-linux.tar.gz
+          mv ./substrate-contracts-node-linux/substrate-contracts-node ./substrate-contracts-node
+          chmod +x substrate-contracts-node
+
+          curl -L -O https://github.com/use-ink/ink-node/releases/download/v0.45.1/ink-node-linux.tar.gz
+          tar -xzf ink-node-linux.tar.gz
+          mv ./ink-node-linux/ink-node ./ink-node
+          chmod +x ink-node
+
+      - name: Spawn networks
+        run: |
+          export PATH=$(pwd):$PATH
+          export RUST_BACKTRACE=full
+          ./ink-node --rpc-port=9955 --state-pruning=archive --blocks-pruning=archive & 
+          ./substrate-contracts-node --dev &
+
+          chmod +x ./e2e/nodes/wait-for-port.sh
+          ./e2e/nodes/wait-for-port.sh 9944 30 &
+          ./e2e/nodes/wait-for-port.sh 9955 30
+
+      - name: Run tests
+        run: yarn workspace e2e-nodes e2e:test

.github/workflows/run-tests.yml

@@ -5,8 +5,10 @@ name: Run Unit Tests
 
 on:
   push:
+    branches: [ main ]
   workflow_dispatch:
   merge_group:
+  pull_request:
 
 jobs:
   unit-tests:

.github/workflows/zombienet-tests.yml

@@ -2,8 +2,10 @@ name: E2E Zombienet Tests
 
 on:
   push:
+    branches: [ main ]
   workflow_dispatch:
   merge_group:
+  pull_request:
 
 jobs:
   zombienet-tests:

e2e/nodes/README.md

@@ -0,0 +1,27 @@
+# e2e-nodes
+
+### Download the node binaries
+
+Download the both `ink-node` and `substrate-contract-node` to your local environment:
+- [ink-node](https://github.com/use-ink/ink-node/releases/tag/v0.43.3)
+- [substrate-contracts-node](https://github.com/paritytech/substrate-contracts-node/releases/tag/v0.42.0)
+
+### Run both nodes at 2 different port
+
+```shell
+# cd to the download folder
+
+# run ink-node at port 9955
+./ink-node --rpc-port=9955 --state-pruning=archive --blocks-pruning=archive 
+
+# run substrate-contracts-node at port 9944
+./substrate-contracts-node --dev --rpc-port=9944
+```
+
+### Run the tests
+
+After getting both node running, we can run the e2e tests by running the following command:
+
+```shell
+yarn workspace e2e-nodes e2e:test
+```

e2e/nodes/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "e2e-nodes",
+  "author": "Thang Vu <thang@dedot.dev>",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "e2e:test": "npx vitest --watch=false --no-file-parallelism"
+  },
+  "dependencies": {
+    "@dedot/chaintypes": "^0.155.0",
+    "@polkadot/keyring": "^13.5.6",
+    "dedot": "^0.17.0",
+    "typink": "workspace:*"
+  },
+  "license": "MIT"
+}

e2e/nodes/src/contracts/README.md

@@ -0,0 +1,7 @@
+## Contracts
+
+### Generate types for `flipper` contracts
+```shell
+# Run from project's root folder
+yarn cli typink -m ./e2e/contracts/src/contracts/flipper_v5.json -o ./e2e/contracts/src/contracts/
+```

e2e/nodes/src/contracts/flipper/constructor-query.d.ts

@@ -0,0 +1,58 @@
+// Generated by dedot cli
+
+import type { Hash, Result } from 'dedot/codecs';
+import type {
+  ConstructorCallOptions,
+  ContractInstantiateResult,
+  GenericConstructorCallResult,
+  GenericConstructorQuery,
+  GenericConstructorQueryCall,
+} from 'dedot/contracts';
+import type { GenericSubstrateApi } from 'dedot/types';
+import type { FlipperFlipperError } from './types.js';
+
+export interface ConstructorQuery<ChainApi extends GenericSubstrateApi> extends GenericConstructorQuery<ChainApi> {
+  /**
+   * Creates a new flipper smart contract initialized with the given value.
+   *
+   * @param {boolean} initValue
+   * @param {ConstructorCallOptions} options
+   *
+   * @selector 0x9bae9d5e
+   **/
+  new: GenericConstructorQueryCall<
+    ChainApi,
+    (
+      initValue: boolean,
+      options?: ConstructorCallOptions,
+    ) => Promise<GenericConstructorCallResult<[], ContractInstantiateResult<ChainApi>>>
+  >;
+
+  /**
+   * Creates a new flipper smart contract initialized to `false`.
+   *
+   * @param {ConstructorCallOptions} options
+   *
+   * @selector 0x61ef7e3e
+   **/
+  newDefault: GenericConstructorQueryCall<
+    ChainApi,
+    (options?: ConstructorCallOptions) => Promise<GenericConstructorCallResult<[], ContractInstantiateResult<ChainApi>>>
+  >;
+
+  /**
+   * Creates a new flipper smart contract with the value being calculate using provided seed.
+   *
+   * @param {Hash} seed
+   * @param {ConstructorCallOptions} options
+   *
+   * @selector 0x6d4cae81
+   **/
+  fromSeed: GenericConstructorQueryCall<
+    ChainApi,
+    (
+      seed: Hash,
+      options?: ConstructorCallOptions,
+    ) => Promise<GenericConstructorCallResult<Result<[], FlipperFlipperError>, ContractInstantiateResult<ChainApi>>>
+  >;
+}

e2e/nodes/src/contracts/flipper/constructor-tx.d.ts

@@ -0,0 +1,57 @@
+// Generated by dedot cli
+
+import type { Hash } from 'dedot/codecs';
+import type {
+  ConstructorTxOptions,
+  GenericConstructorTx,
+  GenericConstructorTxCall,
+  GenericContractApi,
+  GenericInstantiateSubmittableExtrinsic,
+} from 'dedot/contracts';
+import type { GenericSubstrateApi } from 'dedot/types';
+
+export interface ConstructorTx<
+  ChainApi extends GenericSubstrateApi,
+  ContractApi extends GenericContractApi = GenericContractApi,
+> extends GenericConstructorTx<ChainApi> {
+  /**
+   * Creates a new flipper smart contract initialized with the given value.
+   *
+   * @param {boolean} initValue
+   * @param {ConstructorTxOptions} options
+   *
+   * @selector 0x9bae9d5e
+   **/
+  new: GenericConstructorTxCall<
+    ChainApi,
+    (
+      initValue: boolean,
+      options?: ConstructorTxOptions,
+    ) => GenericInstantiateSubmittableExtrinsic<ChainApi, ContractApi>
+  >;
+
+  /**
+   * Creates a new flipper smart contract initialized to `false`.
+   *
+   * @param {ConstructorTxOptions} options
+   *
+   * @selector 0x61ef7e3e
+   **/
+  newDefault: GenericConstructorTxCall<
+    ChainApi,
+    (options?: ConstructorTxOptions) => GenericInstantiateSubmittableExtrinsic<ChainApi, ContractApi>
+  >;
+
+  /**
+   * Creates a new flipper smart contract with the value being calculate using provided seed.
+   *
+   * @param {Hash} seed
+   * @param {ConstructorTxOptions} options
+   *
+   * @selector 0x6d4cae81
+   **/
+  fromSeed: GenericConstructorTxCall<
+    ChainApi,
+    (seed: Hash, options?: ConstructorTxOptions) => GenericInstantiateSubmittableExtrinsic<ChainApi, ContractApi>
+  >;
+}