feat: add click name service

.cspell.json

@@ -1,46 +1,55 @@
 {
-    "version": "0.2",
-    "language": "en",
-    "files": [
-        "**/*.{sol,ts,md}"
-    ],
-    "ignorePaths": [
-        "node_modules",
-        "lib",
-        "out",
-        "cache",
-        "broadcast",
-        "artifacts-zk",
-        "deployments-zk",
-        "cache_hardhat-zk",
-        "zkout"
-    ],
-    "ignoreWords": [
-        "NODL",
-        "Nodle",
-        "depin",
-        "contentsign",
-        "matterlabs",
-        "zksync",
-        "zksolc",
-        "Parachain",
-        "subql",
-        "codegen",
-        "Datasource",
-        "ipfs",
-        "keccak",
-        "IERC",
-        "Mintable",
-        "BOOTLOADER",
-        "devcontainer",
-        "gasleft",
-        "chainid",
-        "myfilebase",
-        "ethersproject",
-        "Numberish",
-        "Blockhash",
-        "Typechain",
-        "Soulbound",
-        "accesscontrolrole"
-    ]
-}
+  "version": "0.2",
+  "language": "en",
+  "files": ["**/*.{sol,ts,md}"],
+  "ignorePaths": [
+    "node_modules",
+    "lib",
+    "out",
+    "cache",
+    "broadcast",
+    "artifacts-zk",
+    "deployments-zk",
+    "cache_hardhat-zk",
+    "zkout",
+    "clk-gateway/src/validators.test.ts"
+  ],
+  "ignoreWords": [
+    "NODL",
+    "Nodle",
+    "depin",
+    "contentsign",
+    "matterlabs",
+    "zksync",
+    "zksolc",
+    "Parachain",
+    "subql",
+    "codegen",
+    "Datasource",
+    "ipfs",
+    "keccak",
+    "IERC",
+    "Mintable",
+    "BOOTLOADER",
+    "devcontainer",
+    "gasleft",
+    "chainid",
+    "myfilebase",
+    "ethersproject",
+    "Numberish",
+    "Blockhash",
+    "Typechain",
+    "Soulbound",
+    "accesscontrolrole",
+    "Pubdata",
+    "Offchain",
+    "Merkle",
+    "inheritdoc",
+    "ENSIP",
+    "MULTICHAIN",
+    "CCIP",
+    "nameservice",
+    "firebaseapp",
+    "permissioned"
+  ]
+}

.github/workflows/container.yml

@@ -0,0 +1,54 @@
+name: Build and Push Container Image
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - aliX/ens-1
+    tags:
+      - v*
+
+# Cancel pending jobs when pushing a new commit
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest-8-cores
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Authenticate to Google Cloud
+        uses: google-github-actions/auth@v2
+        with:
+          project_id: ${{ secrets.PROJECT_ID }}
+          workload_identity_provider: ${{ secrets.WORKLOAD_IDENTITY_PROVIDER }}
+          service_account: ${{ secrets.SERVICE_ACCOUNT_EMAIL }}
+
+      - name: Setup Google Cloud SDK
+        uses: google-github-actions/setup-gcloud@v2
+        with:
+          project_id: ${{ secrets.PROJECT_ID }}
+          install_components: beta
+
+      - name: Authenticate to Artifact Registry
+        run: |-
+          gcloud auth configure-docker us-west1-docker.pkg.dev
+
+      - name: Build and Tag Images
+        run: |-
+          docker build --no-cache \
+            -t us-west1-docker.pkg.dev/${{ secrets.PROJECT_ID }}/service/clk-gateway:latest \
+            -t us-west1-docker.pkg.dev/${{ secrets.PROJECT_ID }}/service/clk-gateway:${{ github.sha }} \
+            ./clk-gateway
+
+      - name: Publish Images
+        run: |-
+          docker push us-west1-docker.pkg.dev/${{ secrets.PROJECT_ID }}/service/clk-gateway:latest
+          docker push us-west1-docker.pkg.dev/${{ secrets.PROJECT_ID }}/service/clk-gateway:${{ github.sha }}

.gitmodules

@@ -4,6 +4,9 @@
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/openzeppelin/openzeppelin-contracts
-[submodule "lib/zksync-contracts"]
-	path = lib/zksync-contracts
-	url = https://github.com/NodleCode/zksync-contracts
+[submodule "lib/zksync-storage-proofs"]
+	path = lib/zksync-storage-proofs
+	url = https://github.com/getclave/zksync-storage-proofs
+[submodule "lib/era-contracts"]
+	path = lib/era-contracts
+	url = https://github.com/matter-labs/era-contracts

.vscode/settings.json

@@ -1,5 +1,13 @@
 {
   "solidity.packageDefaultDependenciesContractsDirectory": "./src",
   "solidity.packageDefaultDependenciesDirectory": "./lib",
-  "solidity.formatter": "forge"
-}
+  "solidity.formatter": "forge",
+  "github.copilot.chat.scopeSelection": true,
+  "github.copilot.chat.localeOverride": "en",
+  "github.copilot.chat.temporalContext.enabled": true,
+  "github.copilot.chat.generateTests.codeLens": true,
+  "github.copilot.chat.inlineChatCompletionTrigger.enabled": true,
+  "github.copilot.chat.inlineChatHint.enabled": true,
+  "github.copilot.chat.search.semanticTextResults": true,
+  "editor.defaultFormatter": null
+}

clk-gateway/.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+.env

clk-gateway/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:20
+
+WORKDIR /usr/src/app
+
+COPY . .
+
+RUN yarn install
+
+RUN yarn build
+
+EXPOSE 8080
+
+CMD ["yarn", "start"]

clk-gateway/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+.tsx?$": ["ts-jest",{}],
+  },
+};

clk-gateway/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "clk-gateway",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "@types/node": "^22.9.4",
+    "cors": "^2.8.5",
+    "dotenv": "^16.4.5",
+    "ethers": "^6.13.4",
+    "express": "^4.21.1",
+    "express-validator": "^7.2.0",
+    "firebase": "^11.0.2",
+    "firebase-admin": "^13.0.1",
+    "typescript": "^5.7.2",
+    "zksync-ethers": "^6.15.1"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.17",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.7",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2"
+  },
+  "scripts": {
+    "fmt": "prettier --write src/**/*.ts",
+    "test": "jest",
+    "start": "ts-node src/index.ts",
+    "dev": "nodemon src/index.ts",
+    "build": "tsc",
+    "serve": "yarn build && yarn start",
+    "createToken": "ts-node src/createToken.ts"
+  }
+}

clk-gateway/src/createToken.ts

@@ -0,0 +1,76 @@
+/**
+ * This script is a tool for test purposes that uses Firebase Admin service account to create a custom token for a user given its UID as the script input.
+ *
+ * The script performs the following steps:
+ * 1. Manually forces the emailVerified status for the specified user to true, avoiding the need to verify the user's email.
+ * 2. Uses Firebase Admin SDK to create a custom token for the user.
+ * 3. Uses Firebase Client SDK to sign in the user with the custom token and retrieve the ID token.
+ * 4. Prints the ID token, which can be used for POST requests on /registerL2 as the bearer token.
+ *
+ * Environment variables required:
+ * - SERVICE_ACCOUNT_KEY: The Firebase Admin service account key in JSON format.
+ * - FIREBASE_API_KEY: The Firebase API key.
+ * - FIREBASE_PROJECT_ID: The Firebase project ID.
+ *
+ * Command-line arguments:
+ * - userUid: The UID of the user for whom the custom token is to be created. Go to the Firebase Console to find the UID of the user.
+ *
+ * Usage:
+ * ```sh
+ * # Note 1: Do not forget to build the project before running the script
+ * # Note 2: Do not forget to set the environment variables before running the script
+ * # Note 3: There is a possibility that the first time you create a token its email remain unverified. Try to create a second token and use that in that case.
+ * yarn createToken <userUid>
+ * ```
+ *
+ * @module createToken
+ */
+
+import admin from "firebase-admin";
+import { getAuth, signInWithCustomToken } from "firebase/auth";
+import { initializeApp } from "firebase/app";
+
+import dotenv from "dotenv";
+dotenv.config();
+
+const serviceAccountKey = process.env.SERVICE_ACCOUNT_KEY!;
+const serviceAccount = JSON.parse(serviceAccountKey);
+admin.initializeApp({
+  credential: admin.credential.cert(serviceAccount as admin.ServiceAccount),
+});
+const firebaseClientConfig = {
+  apiKey: process.env.FIREBASE_API_KEY!,
+  authDomain: `${process.env.FIREBASE_PROJECT_ID!}.firebaseapp.com`,
+};
+const app = initializeApp(firebaseClientConfig);
+const auth = getAuth(app);
+
+// Get the UID from the command-line arguments
+const userUid: string | undefined = process.argv[2];
+
+if (!userUid) {
+  console.error("Error: Please provide a user UID as an argument.");
+  process.exit(1);
+}
+
+async function main(uid: string): Promise<void> {
+  try {
+    admin
+      .auth()
+      .updateUser(uid, { emailVerified: true })
+      .then((userRecord) => {
+        console.log(`Successfully updated user: ${userRecord.email}`);
+      })
+      .catch((error) => {
+        console.error("Error updating user:", error);
+      });
+    const customToken = await admin.auth().createCustomToken(uid);
+    const userCredential = await signInWithCustomToken(auth, customToken);
+    const idToken = await userCredential.user.getIdToken();
+    console.log("ID Token:", idToken);
+  } catch (error) {
+    console.error("Error generating token:", error);
+  }
+}
+
+main(userUid);

clk-gateway/src/helpers.test.ts

@@ -0,0 +1,13 @@
+import { toLengthPrefixedBytes } from "./helpers";
+
+describe("toLengthPrefixedBytes", () => {
+  test("example.click.eth", () => {
+    const result = toLengthPrefixedBytes("example", "click", "eth");
+    expect(result).toEqual(
+      Uint8Array.from([
+        7, 101, 120, 97, 109, 112, 108, 101, 5, 99, 108, 105, 99, 107, 3, 101,
+        116, 104,
+      ]),
+    );
+  });
+});