Merge pull request #3 from ceptor-club/personal/allan/onboarding

onboarding workflow - user register API

Author: allanma88

packages/nextjs/.env.example

@@ -5,9 +5,10 @@
 
 # If not set, we provide default values (check `scaffold.config.ts`) so developers can start prototyping out of the box,
 # but we recommend getting your own API Keys for Production Apps.
-
-# To access the values stored in this env file you can use: process.env.VARIABLENAME
-# You'll need to prefix the variables names with NEXT_PUBLIC_ if you want to access them on the client side.
-# More info: https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables
 NEXT_PUBLIC_ALCHEMY_API_KEY=
 NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID=
+
+# This is required, no default values, if you don't known, you can ask in the discord channel
+MONGO_CONN_STR=
+MONGO_DB_NAME=
+

packages/nextjs/README.md

@@ -0,0 +1,40 @@
+# How to call the restful API
+
+## Register user API
+
+Below is an example of how to call user API
+
+```
+POST http://localhost:3000/api/user
+Content-Type: application/json
+ 
+{
+"id": "did:ethr:0xaa36a7:0xAD849E351533Db54D0BD22De977a653edfd9EEb8",
+"name": "user",
+"email": "[email protected]",
+"role": "other",
+"projects": ["tech", "game" ],
+"initiative": 8,
+"contactMethod": "email",
+"indiscord": false
+}
+ 
+HTTP/1.1 200 OK
+Content-Type: application/json; charset=utf-8
+ETag: "k5xu2dpe1l2b"
+Content-Length: 83
+Vary: Accept-Encoding
+Date: Wed, 22 May 2024 12:10:24 GMT
+Connection: keep-alive
+Keep-Alive: timeout=5
+ 
+{"message":"user 0xaa36a7:0xAD849E351533Db54D0BD22De977a653edfd9EEb8 user joined."}
+```
+
+### how to specify the user id
+
+the id is the did format, for ethrethereum address, its format is: did:ethr:<chainid>:<ethr address>
+the chainid should be hex format, you can find the chainid for each network in the following link, you can omit the chainid for mainnet.
+https://github.com/uport-project/ethr-did-registry?tab=readme-ov-file#contract-deployments
+
+the ethr address should be hex format.

packages/nextjs/app/api/user/route.ts

@@ -0,0 +1,31 @@
+import getConfig from "next/config";
+import { DuplicateUserError } from "../../../models/errors";
+import { User } from "../../../models/user";
+import { saveUser } from "../../../services/mongo/mongo";
+import { Resolver, parse } from "did-resolver";
+import ethr from "ethr-did-resolver";
+
+export async function POST(request: Request) {
+  const { serverRuntimeConfig } = getConfig();
+  const ethrResolver = ethr.getResolver(serverRuntimeConfig.providerConfig);
+  const resolver = new Resolver(ethrResolver);
+
+  const user: User = await request.json();
+  const did = parse(user.id);
+  const doc = await resolver.resolve(user.id);
+  if (doc.didResolutionMetadata.error || did === null) {
+    return new Response(`invalid user id: ${user.id}.`, { status: 400 });
+  }
+
+  user.address = did.id;
+  try {
+    await saveUser(user);
+    return new Response(`user ${user.address} ${user.name} joined.`, { status: 400 });
+  } catch (err) {
+    if (err instanceof DuplicateUserError) {
+      return new Response(`user ${user.id} already exists.`, { status: 400 });
+    } else {
+      return new Response(`internal server error: ${err}.`, { status: 500 });
+    }
+  }
+}

packages/nextjs/models/errors.ts

@@ -0,0 +1 @@
+export class DuplicateUserError extends Error {}

packages/nextjs/models/user.ts

@@ -0,0 +1,15 @@
+export interface User {
+  id: string;
+  name: string;
+  email: string;
+  address: string;
+  role: string;
+  projects: string[];
+  initiative: number;
+  contactMethod: string;
+  indiscord: boolean;
+  background: string;
+  availableTime: string;
+  links: string[];
+  attraction: string;
+}

packages/nextjs/next.config.js

@@ -1,4 +1,5 @@
 // @ts-check
+const { MONGO_CONN_STR, MONGO_DB_NAME } = process.env;
 
 /** @type {import('next').NextConfig} */
 const nextConfig = {
@@ -9,6 +10,18 @@ const nextConfig = {
   eslint: {
     ignoreDuringBuilds: process.env.NEXT_PUBLIC_IGNORE_BUILD_ERROR === "true",
   },
+  serverRuntimeConfig: {
+    providerConfig: {
+      networks: [
+        { name: "mainnet", rpcUrl: "https://eth.drpc.org" },
+        { name: "sepolia", rpcUrl: "https://sepolia.drpc.org", registry: "0x03d5003bf0e79c5f5223588f347eba39afbc3818" },
+      ],
+    },
+    mongoConfig: {
+      connectionStr: MONGO_CONN_STR,
+      db: MONGO_DB_NAME,
+    },
+  },
   webpack: config => {
     config.resolve.fallback = { fs: false, net: false, tls: false };
     config.externals.push("pino-pretty", "lokijs", "encoding");

packages/nextjs/package.json

@@ -21,6 +21,11 @@
     "@uniswap/v2-sdk": "^3.0.1",
     "blo": "^1.0.1",
     "daisyui": "4.5.0",
+    "did-jwt": "^8.0.4",
+    "did-jwt-vc": "^4.0.4",
+    "ethr-did": "^3.0.21",
+    "ethr-did-resolver": "^10.1.5",
+    "mongodb": "^4.14.0",
     "next": "^14.0.4",
     "next-themes": "^0.2.1",
     "nprogress": "^0.2.0",

packages/nextjs/services/mongo/mongo.ts

@@ -0,0 +1,45 @@
+import getConfig from "next/config";
+import { DuplicateUserError } from "../../models/errors";
+import { User } from "../../models/user";
+import { InsertOneResult, MongoClient, MongoServerError, WithId } from "mongodb";
+
+const { serverRuntimeConfig } = getConfig();
+
+if (!serverRuntimeConfig.mongoConfig.connectionStr) {
+  throw new Error("mongo connection string is missing, please check MONGO_CONN_STR in your env file");
+}
+
+if (!serverRuntimeConfig.mongoConfig.db) {
+  throw new Error("mongo db name is missing, please check MONGO_DB_NAME in your env file");
+}
+
+const client = new MongoClient(serverRuntimeConfig.mongoConfig.connectionStr);
+const usersCollection = client.db(serverRuntimeConfig.mongoConfig.db).collection<User>("User");
+
+//function to connect to mongoDB and save a user to the database
+export async function saveUser(user: User): Promise<InsertOneResult<User>> {
+  try {
+    return await usersCollection.insertOne(user);
+  } catch (err) {
+    if (err instanceof MongoServerError && err.code === 11000) {
+      throw new DuplicateUserError();
+    }
+    throw err;
+  }
+}
+
+//function to connect to mongoDB and get a user from the database
+export async function getUserByAddress(address: string): Promise<WithId<User> | null> {
+  return await usersCollection.findOne({ address: address });
+}
+
+//function to get user by _id
+export async function getUserById(id: string): Promise<WithId<User> | null> {
+  return await usersCollection.findOne({ id: id });
+}
+
+//function to list all users
+export async function getAllUsers(): Promise<WithId<User>[]> {
+  const usersCursor = usersCollection.find();
+  return await usersCursor.toArray();
+}