Merge branch 'main' into fet-1613

.github/workflows/knip.yaml

@@ -0,0 +1,22 @@
+name: Knip
+
+on: [push]
+
+jobs:
+  knip:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm
+        run: corepack enable pnpm
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'pnpm'
+
+      - run: pnpm install --frozen-lockfile
+
+      - run: pnpm knip

.github/workflows/pages-deployment.yaml

@@ -45,7 +45,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
 
       - run: pnpm install --frozen-lockfile
@@ -66,6 +66,8 @@ jobs:
         run: |
           mkdir -p ./out/sitemaps
           pnpm generate:sitemaps
+        env:
+          SITEMAP_GRAPH_KEY: ${{ secrets.SITEMAP_GRAPH_KEY }}
 
       - name: Publish
         uses: cloudflare/pages-action@v1

.github/workflows/test.yaml

@@ -17,7 +17,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
 
       - run: pnpm install --frozen-lockfile
@@ -40,7 +40,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
 
       - run: pnpm install --frozen-lockfile
@@ -73,7 +73,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
 
       - run: pnpm install --frozen-lockfile
@@ -107,7 +107,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
 
       - run: pnpm install --frozen-lockfile
@@ -156,7 +156,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
 
       - run: pnpm install --frozen-lockfile

.gitignore

@@ -63,8 +63,6 @@ tsconfig.vitest-temp.json
 /archives
 /data
 /test-environment
-/ganache
-
 # hardhat
 /cache
 /artifacts

.nvmrc

@@ -1 +1 @@
-18.18.2
+20.13.1

.prettierignore

@@ -9,7 +9,6 @@ artifacts
 cache
 coverage
 data
-ganache
 out
 subgraphs
 

.vscode/settings.json

@@ -25,5 +25,8 @@
   "i18n-ally.localesPaths": [
     "public/locales"
   ],
-  "i18n-ally.keystyle": "nested"
+  "i18n-ally.keystyle": "nested",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
 }

README.md

@@ -507,3 +507,62 @@ Our testing philosophy is user-centric, meaning we want to write out tests so th
 A user generally clicks, types and swipes, and so most tests should include one of these actions. A user may also load a page in a specific state (by clicking, typing or swiping outside of the app) so sometimes we just want to check a page renders correctly. The vast majority of our tests will be of these kinds.
 
 For deeper parts of the codebase that aren't directly related to a user interaction, such as utility functions, the user is the developer. So simply test the code in the way a developer would use it.
+
+## Knip Configuration Guide
+
+### 1. Install Knip:
+
+Install Knip as a development dependency in your project:
+
+```bash
+pnpm add -D knip
+```
+
+### 2. Add a knip script to your package.json:
+
+Add a script to your package.json for easy access to Knip:
+
+```json
+{
+  "scripts": {
+    ...,
+    "knip": "knip",
+    "knip:fix": "knip --fix --allow-remove-files"
+  }
+}
+```
+
+### 3. Create Knip Configuration File:
+
+Create a `knip.config.ts` file at the root of your project. For more detail of configuration options, refer to the [knip.config.ts file](knip.config.ts) in the ENSDomains repository.
+
+### 4. Run Knip:
+
+To analyze your project, run Knip using the following command:
+
+```bash
+pnpm knip
+```
+Knip will exit with code `1` if any issues are found, such as unused files, dependencies, or exports that need to be removed.
+
+### 5. Review and Remove Unused Files
+
+After Knip completes its analysis, review the results. Manually remove any unused files that are safe to delete, or let Knip handle it automatically with the following command:
+
+```bash
+pnpm knip:fix
+```
+
+Ensure you carefully examine any files marked for removal to avoid accidentally deleting necessary code.
+
+### 6. Run Unit Tests and E2E Tests:
+
+After removing files, it's important to run your unit and end-to-end tests to ensure that everything is still functioning correctly:
+
+```bash
+pnpm test:coverage
+```
+
+```bash
+pnpm e2e
+```

e2e/specs/stateless/registerName.spec.ts

@@ -1,9 +1,9 @@
 import { expect } from '@playwright/test'
-import { Web3RequestKind } from 'headless-web3-provider'
 import { Hash, isHash } from 'viem'
 
 import { ethRegistrarControllerCommitSnippet } from '@ensdomains/ensjs/contracts'
 import { setPrimaryName } from '@ensdomains/ensjs/wallet'
+import { Web3RequestKind } from '@ensdomains/headless-web3-provider'
 
 // import { secondsToDateInput } from '@app/utils/date'
 import { daysToSeconds, yearsToSeconds } from '@app/utils/time'
@@ -28,7 +28,6 @@ test.describe.serial('normal registration', () => {
     page,
     login,
     accounts,
-    provider,
     time,
     makePageObject,
   }) => {
@@ -112,7 +111,7 @@ test.describe.serial('normal registration', () => {
     await expect(waitButton).toBeDisabled()
     const startTimerButton = page.getByTestId('start-timer-button')
     await expect(startTimerButton).not.toBeVisible()
-    await provider.increaseTime(60)
+    await testClient.increaseTime({ seconds: 60 })
     await expect(page.getByTestId('finish-button')).toBeEnabled()
 
     // should save the registration state and the transaction status
@@ -159,7 +158,6 @@ test.describe.serial('normal registration', () => {
 
   test('should allow registering a non-primary name', async ({
     page,
-    provider,
     accounts,
     time,
     login,
@@ -192,7 +190,7 @@ test.describe.serial('normal registration', () => {
     await page.getByTestId('next-button').click()
     await transactionModal.confirm()
     await expect(page.getByTestId('countdown-complete-check')).toBeVisible()
-    await provider.increaseTime(60)
+    await testClient.increaseTime({ seconds: 60 })
     await page.getByTestId('finish-button').click()
     await transactionModal.confirm()
     await page.getByTestId('view-name').click()
@@ -205,7 +203,6 @@ test.describe.serial('normal registration', () => {
 test('should allow registering a premium name', async ({
   page,
   login,
-  provider,
   accounts,
   makeName,
   makePageObject,
@@ -236,7 +233,7 @@ test('should allow registering a premium name', async ({
   await transactionModal.confirm()
 
   await expect(page.getByTestId('countdown-complete-check')).toBeVisible()
-  await provider.increaseTime(120)
+  await testClient.increaseTime({ seconds: 120 })
   await page.getByTestId('finish-button').click()
   await transactionModal.confirm()
 
@@ -249,7 +246,6 @@ test('should allow registering a premium name', async ({
 test('should allow registering a name and resuming from the commit toast', async ({
   page,
   login,
-  provider,
   time,
   makePageObject,
 }) => {
@@ -266,13 +262,13 @@ test('should allow registering a name and resuming from the commit toast', async
   await page.getByTestId('next-button').click()
   await page.getByTestId('next-button').click()
 
-  await provider.setAutomine(false)
+  await testClient.setAutomine(false)
 
   await transactionModal.confirm()
 
   await page.getByTestId('transaction-modal-sent-button').click()
   await page.goto('/')
-  await provider.setAutomine(true)
+  await testClient.setAutomine(true)
 
   await page.getByTestId('notification-continue-button').click()
   await expect(page).toHaveURL(`/${name}/register`)
@@ -351,7 +347,6 @@ test('should allow registering with a specific date', async ({ page, login, make
 test('should allow registering a premium name with a specific date', async ({
   page,
   login,
-  provider,
   accounts,
   makeName,
   makePageObject,
@@ -411,7 +406,7 @@ test('should allow registering a premium name with a specific date', async ({
   await transactionModal.confirm()
 
   await expect(page.getByTestId('countdown-complete-check')).toBeVisible()
-  await provider.increaseTime(120)
+  await testClient.increaseTime({ seconds: 120 })
   await page.getByTestId('finish-button').click()
   await transactionModal.confirm()
 
@@ -424,7 +419,6 @@ test('should allow registering a premium name with a specific date', async ({
 test('should allow registering a premium name for two months', async ({
   page,
   login,
-  provider,
   accounts,
   makeName,
   makePageObject,
@@ -484,7 +478,7 @@ test('should allow registering a premium name for two months', async ({
   await transactionModal.confirm()
 
   await expect(page.getByTestId('countdown-complete-check')).toBeVisible()
-  await provider.increaseTime(120)
+  await testClient.increaseTime({ seconds: 120 })
   await page.getByTestId('finish-button').click()
   await transactionModal.confirm()
 
@@ -497,7 +491,6 @@ test('should allow registering a premium name for two months', async ({
 test('should not allow registering a premium name for less than 28 days', async ({
   page,
   login,
-  provider,
   accounts,
   makeName,
   makePageObject,
@@ -574,7 +567,7 @@ test('should not allow registering a premium name for less than 28 days', async
   await transactionModal.confirm()
 
   await expect(page.getByTestId('countdown-complete-check')).toBeVisible()
-  await provider.increaseTime(120)
+  await testClient.increaseTime({ seconds: 120 })
   await page.getByTestId('finish-button').click()
   await transactionModal.confirm()
 
@@ -588,7 +581,6 @@ test('should allow normal registration for a month', async ({
   page,
   login,
   accounts,
-  provider,
   time,
   makePageObject,
 }) => {
@@ -692,7 +684,7 @@ test('should allow normal registration for a month', async ({
   // should show countdown
   await expect(page.getByTestId('countdown-circle')).toBeVisible()
   await expect(page.getByTestId('countdown-complete-check')).toBeVisible()
-  await provider.increaseTime(60)
+  await testClient.increaseTime({ seconds: 60 })
   await expect(page.getByTestId('finish-button')).toBeEnabled()
 
   // should save the registration state and the transaction status
@@ -717,7 +709,6 @@ test('should not allow normal registration less than 28 days', async ({
   page,
   login,
   accounts,
-  provider,
   time,
   makePageObject,
 }) => {
@@ -832,7 +823,7 @@ test('should not allow normal registration less than 28 days', async ({
   // should show countdown
   await expect(page.getByTestId('countdown-circle')).toBeVisible()
   await expect(page.getByTestId('countdown-complete-check')).toBeVisible()
-  await provider.increaseTime(60)
+  await testClient.increaseTime({ seconds: 60 })
   await expect(page.getByTestId('finish-button')).toBeEnabled()
 
   // should save the registration state and the transaction status
@@ -857,7 +848,6 @@ test('should be able to detect an existing commit created on a private mempool',
   page,
   login,
   accounts,
-  provider,
   time,
   wallet,
   makePageObject,
@@ -926,7 +916,7 @@ test('should be able to detect an existing commit created on a private mempool',
     // should show countdown
     await expect(page.getByTestId('countdown-circle')).toBeVisible()
     await expect(page.getByTestId('countdown-circle')).toContainText(/^[0-6]?[0-9]$/)
-    await provider.increaseTime(60)
+    await testClient.increaseTime({ seconds: 60 })
     await expect(page.getByTestId('countdown-complete-check')).toBeVisible({ timeout: 10000 })
   })
 

e2e/specs/stateless/setPrimary.spec.ts

@@ -157,8 +157,6 @@ test.describe('profile', () => {
   }) => {
     test.slow()
 
-    // const reverseRegistrar = await contracts.get('ReverseRegistrar', { signer: 'user' })
-    // await reverseRegistrar.setName('')
     await setPrimaryName(walletClient, {
       name: '',
       account: createAccounts().getAddress('user') as `0x${string}`,

e2e/specs/stateless/settings.spec.ts

@@ -45,7 +45,7 @@ test.describe('Transactions', () => {
 
     await transactionMocal.authorize()
 
-    await expect(page.getByText('Test transaction')).toBeVisible()
+    await expect(page.getByText('Test transaction', { exact: true })).toBeVisible()
 
     await expect(page.getByTestId('toast-desktop')).toBeVisible()
     await expect(page.getByTestId('toast-desktop')).toHaveText(/Transaction Successful/)