Merge pull request #10 from ChainSafe/submoduleIntegrationTest

Setup for integration tests, CI, open-creator-rails submodule

Author: irubido

.github/workflows/ci.yml

@@ -0,0 +1,106 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  CI:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run lint
+        run: npm run lint
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    needs: CI
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run build
+        run: npm run build
+
+  test:
+    name: Test (Vitest)
+    runs-on: ubuntu-latest
+    needs: CI
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+  integration:
+    name: Integration Tests (Anvil + Forge)
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: "stable"
+          cache: true
+
+      - name: Run integration tests
+        run: |
+          export PATH="$HOME/.foundry/bin:$HOME/.cargo/bin:$PATH"
+          anvil --version
+          forge --version
+          npm run test:integration
+

.gitignore

@@ -21,3 +21,5 @@ pnpm-debug.log*
 
 # misc
 *.tsbuildinfo
+
+act.tgz

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "open-creator-rails"]
+	path = open-creator-rails
+	url = https://github.com/ChainSafe/open-creator-rails.git

README.md

@@ -36,5 +36,57 @@ const sdk = createOcrSdk({
 });
 ```
 
+## Local Node (Anvil) + SDK Testing
+
+This SDK can be tested end-to-end against a local Anvil chain using the contracts from the `open-creator-rails` submodule.
+
+### Prerequisites
+1. Install Foundry (provides `anvil` + `forge`).
+2. Initialize the contracts submodule:
+```bash
+git submodule update --init --recursive
+```
+
+### Run integration tests (recommended)
+These tests start Anvil, deploy `TestToken` and `AssetRegistry`, run `subscribe`/`getSubscriptionStatus`, advance time, and then run `claimCreatorFee`.
+
+```bash
+npm run test:integration
+```
+
+### Manual debugging (optional)
+Start Anvil on the default port:
+```bash
+anvil --chain-id 31337 --port 8545
+```
+
+Then point your SDK clients at it (as shown in the `Usage` section above) by setting:
+```bash
+export RPC_URL=http://127.0.0.1:8545
+```
+
+## Maintenance
+
+### Updating the `open-creator-rails` submodule
+This repo includes `open-creator-rails` as a git submodule (used for contract ABIs + deployment JSON). When upstream `main` changes, update the submodule and commit the new submodule SHA (the gitlink) in this repo.
+
+#### Recommended update workflow
+1. Ensure submodules are initialized:
+```bash
+git submodule update --init --recursive
+```
+
+2. Update the submodule to the newest remote commit:
+```bash
+git submodule update --remote --merge open-creator-rails
+```
+
+3. Commit the updated gitlink SHA in this repository:
+```bash
+git status
+git add open-creator-rails
+git commit -m "chore: update open-creator-rails submodule"
+```
+
 
 

eslint.config.js

@@ -0,0 +1,55 @@
+import js from "@eslint/js";
+import tseslint from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+
+export default [
+  {
+    ignores: ["dist/**", "node_modules/**", "open-creator-rails/**"],
+  },
+  js.configs.recommended,
+  {
+    files: ["**/*.ts"],
+    languageOptions: {
+      parser: tsParser,
+      sourceType: "module",
+      ecmaVersion: "latest",
+      globals: {
+        // Node 18+ global fetch (our SDK uses `fetch` in Node/ESM).
+        fetch: "readonly",
+
+        // Node globals used by integration tests.
+        process: "readonly",
+        setTimeout: "readonly",
+        setInterval: "readonly",
+        clearTimeout: "readonly",
+        clearInterval: "readonly",
+
+        // Vitest globals used in tests.
+        describe: "readonly",
+        it: "readonly",
+        expect: "readonly",
+        vi: "readonly",
+        beforeEach: "readonly",
+        beforeAll: "readonly",
+        afterAll: "readonly",
+        test: "readonly",
+      },
+    },
+    plugins: {
+      "@typescript-eslint": tseslint,
+    },
+    rules: {
+      ...tseslint.configs.recommended.rules,
+
+      // This repo uses `as any` in mocks/test doubles.
+      "@typescript-eslint/no-explicit-any": "off",
+
+      // Type assertions are used for hex/address branded types.
+      "@typescript-eslint/consistent-type-assertions": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+    },
+  },
+];
+