Merge branch 'main' into feature/NO-JIRA/use-seperate-oas-spec

.github/workflows/pr.yaml

@@ -21,108 +21,28 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.ref }}
           fetch-depth: 0
+
       - name: setup
         uses: ./.github/actions/setup
 
       - name: Syncpack
         run: yarn syncpack:check
 
-  detect:
-    name: Detect Node engine version change
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Get Node engine version from package.json
-        id: get_package_json_node_engine_version
-        run: |
-          node_engine_major_version=$(jq -r '.engines.node' ./sdk/package.json | sed 's/^>=//' | cut -d. -f1)
-          echo "::set-output name=node_engine_major_version::$node_engine_major_version"
-
-      - name: Get Node.js version from .nvmrc
-        id: get_nvmrc_node_version
-        run: echo "::set-output name=nvmrc_node_version::$(head -n 1 .nvmrc | cut -d. -f1)"
-
-      - name: Check Node.js engine version change
-        run: |
-          package_version_major=$(echo "${{ steps.get_package_json_node_engine_version.outputs.node_engine_major_version }}")
-          nvmrc_version_major=$(echo "${{ steps.get_nvmrc_node_version.outputs.nvmrc_node_version }}")
-          if [ "$package_version_major" != "$nvmrc_version_major" ]; then
-            echo "Node.js engine version has changed"
-            exit 1
-          else
-            echo "Node.js engine version has not changed"
-          fi
-
-  build-sdk:
-    name: Build SDK
+  build-lint-test-typecheck-sdk:
+    name: Build, Lint, Test & Typecheck SDK
     runs-on: ubuntu-latest-8-cores
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.ref }}
           fetch-depth: 0
-      - name: setup
-        uses: ./.github/actions/setup
-      - name: Build
-        run: yarn nx affected --target=build
-
-  typecheck-sdk:
-    name: Typecheck SDK
-    runs-on: ubuntu-latest-4-cores
-    needs: build-sdk
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          fetch-depth: 0
-      - name: setup
-        uses: ./.github/actions/setup
-
-      - name: Typecheck
-        run: yarn typecheck
 
-  test-sdk:
-    name: Test SDK
-    runs-on: ubuntu-latest-8-cores
-    needs: build-sdk
-    env:
-      NODE_OPTIONS: --max-old-space-size=14366
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          fetch-depth: 0
       - name: setup
         uses: ./.github/actions/setup
 
-      - name: Test
-        run: yarn test --configuration=ci
-
-      - name: Upload SDK test coverage artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: coverages
-          path: ./packages/**/coverage/*
-
-  lint-sdk:
-    name: Lint SDK
-    runs-on: ubuntu-latest-4-cores
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          fetch-depth: 0
-      - name: setup
-        uses: ./.github/actions/setup
-
-      - name: Lint
-        run: yarn lint
+      - name: Build, Lint, Test & Typecheck
+        run: yarn nx affected -t build,lint,test,typecheck 
 
   build-lint-test-examples:
     name: Build, Lint & Test Examples
@@ -152,11 +72,11 @@ jobs:
         run: yarn test:examples
 
 
-  func-test-imx:
-    name: imx func tests
-    runs-on: ubuntu-latest-4-cores
-    needs: build-sdk
+  func-tests:
+    name: Functional tests
+    runs-on: ubuntu-latest-8-cores
     env:
+      # imx envs
       NETWORK: sepolia
       TEST_ALCHEMY_API_KEY: ${{ secrets.TEST_ALCHEMY_API_KEY }}
       PUBLIC_API_URL: "https://api.sandbox.x.immutable.com/v1"
@@ -170,26 +90,8 @@ jobs:
       TEST_WALLET_BANKER_PRIVATE_KEY: ${{ secrets.TEST_WALLET_BANKER_PRIVATE_KEY }}
       TEST_WALLET_BANKER_STARK_PRIVATE_KEY: ${{ secrets.TEST_WALLET_BANKER_STARK_PRIVATE_KEY }}
       TEST_STARKEX_BATCH_SIZE: 500
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
-          fetch-depth: 0
-      - name: setup
-        uses: ./.github/actions/setup
-
-      - name: Setup tests
-        uses: ./.github/actions/setup-tests
-
-      - name: test
-        run: yarn workspace @tests/func-tests-imx func-test:ci
 
-  func-test-zkevm:
-    name: zkevm func tests
-    runs-on: ubuntu-latest-8-cores
-    needs: build-sdk
-    env:
+      # zkevm envs
       ZKEVM_ORDERBOOK_BANKER: ${{ secrets.ZKEVM_ORDERBOOK_BANKER }}
       ZKEVM_ORDERBOOK_ERC721: "0xBE8B131f39825282Ace9eFf99C0Bb14972417b49"
       ZKEVM_ORDERBOOK_ERC1155: "0x2efB9B7810B1d1520c0822aa20F1889ABd2c2146"
@@ -204,12 +106,12 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.ref }}
           fetch-depth: 0
-
+          
       - name: setup
         uses: ./.github/actions/setup
 
-      - name: Setup tests
-        uses: ./.github/actions/setup-tests
+      - name: Prepare tests
+        run: yarn prepare:tests
 
-      - name: test
-        run: yarn workspace @tests/func-tests-zkevm func-test:ci
+      - name: Run functional tests
+        run: FORCE_COLOR=1 yarn workspaces foreach -Apt --include='@tests/**' run func-test:ci

examples/orderbook/create-bid-with-nextjs/.env.example

@@ -0,0 +1,2 @@
+NEXT_PUBLIC_PUBLISHABLE_KEY=
+NEXT_PUBLIC_CLIENT_ID=

examples/orderbook/create-bid-with-nextjs/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "root": true,
+  "extends": [
+    "next/core-web-vitals"
+  ]
+}

examples/orderbook/create-bid-with-nextjs/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

examples/orderbook/create-bid-with-nextjs/README.md

@@ -0,0 +1,68 @@
+This example application demonstrates how to create a bid using the Immutable SDK. The application connects to the Immutable Sandbox environment and requires a valid client ID and publishable API key (which can be retrieved from the Immutable Hub).
+
+In order to create a bid, a valid ERC721 or ERC1155 token must be provided. The application will prompt the user to connect their Passport wallet and approve the token. Once the token is approved, a bid with the desired price and quantity is created.
+
+## Features
+- Create a bid for an ERC721 token
+- Create a bid for an ERC1155 token
+
+## Prerequisites
+- Node.js
+
+## Getting Started
+1. Install the dependencies:
+
+```bash
+yarn
+```
+
+2. Copy the `.env.example` file to `.env`:
+
+```bash
+cp .env.example .env
+```
+
+3. Replace the `NEXT_PUBLIC_PUBLISHABLE_KEY` and `NEXT_PUBLIC_CLIENT_ID` with your own values from the Immutable Hub.
+
+
+4. Run the development server:
+
+```bash
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser and you'll be navigated to the home screen.
+
+## Create bid for ERC721 token
+1. Click on the "Create ERC721 Bid" button
+2. Connect your Passport wallet
+3. Enter the following details
+   - NFT Contract Address: The contract address of the ERC721 token
+   - NFT Token ID: The Token ID of the ERC721 token
+   - ERC20 Currency Contract Address: The contract address of ERC20 you'd like to use to make payment for the item
+   - Currency Amount: The amount of currency you'd like use
+4. Click on the "Create Bid" button
+5. Approve the ERC20 token balance for trading
+6. Sign the bid
+7. If successful, the bid will be created and the order ID will be displayed
+8. If unsuccessful, an error message will be displayed
+
+## Create bid for ERC1155 token
+1. Click on the "Create ERC1155 Bid" button
+2. Connect your Passport wallet
+3. Enter the following details
+    - NFT Contract Address: The contract address of the ERC1155 token
+    - NFT Token ID: The Token ID of the ERC1155 token
+    - NFT Token Quantity: The amount of ERC1155 tokens you'd like to bid for
+    - ERC20 Currency Contract Address: The contract address of ERC20 you'd like to use to make payment for the item
+    - Currency Amount: The amount of currency you'd like use
+4. Click on the "Create Bid" button
+5. Approve the ERC20 token balance for trading
+6. Sign the bid
+7. If successful, the bid will be created and the order ID will be displayed
+8. If unsuccessful, an error message will be displayed
+
+## Required Environment Variables
+
+- NEXT_PUBLIC_PUBLISHABLE_KEY // replace with your publishable API key from Hub
+- NEXT_PUBLIC_CLIENT_ID // replace with your client ID from Hub

examples/orderbook/create-bid-with-nextjs/next.config.mjs

@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default nextConfig;

examples/orderbook/create-bid-with-nextjs/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@examples/create-bid-with-nextjs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint",
+    "test": "playwright test"
+  },
+  "dependencies": {
+    "@biom3/react": "^0.26.1",
+    "@ethersproject/providers": "^5.7.2",
+    "@imtbl/sdk": "latest",
+    "ethers": "^5.7.2",
+    "next": "14.2.10",
+    "react": "^18",
+    "react-dom": "^18"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.45.3",
+    "@types/node": "^20",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "eslint": "^8",
+    "eslint-config-next": "14.2.7",
+    "typescript": "^5.6.2"
+  }
+}

examples/orderbook/create-bid-with-nextjs/playwright.config.ts

@@ -0,0 +1,30 @@
+import { defineConfig, devices } from "@playwright/test";
+
+export default defineConfig({
+    testDir: "./tests",
+    fullyParallel: true,
+    forbidOnly: !!process.env.CI,
+    retries: process.env.CI ? 2 : 0,
+    workers: "80%",
+    reporter: "html",
+
+    use: {
+        baseURL: "http://localhost:3000",
+        trace: "on-first-retry",
+    },
+
+    projects: [
+        { name: "chromium", use: { ...devices["Desktop Chrome"] } },
+        { name: "firefox", use: { ...devices["Desktop Firefox"] } },
+        { name: "webkit", use: { ...devices["Desktop Safari"] } },
+
+        { name: "Mobile Chrome", use: { ...devices["Pixel 5"] } },
+        { name: "Mobile Safari", use: { ...devices["iPhone 12"] } },
+    ],
+
+    webServer: {
+        command: "yarn start",
+        url: "http://localhost:3000",
+        reuseExistingServer: !process.env.CI,
+    },
+});