feat: PRO-2395 sequelize integration to backend and property name upd…

…ates for APIKey entity references in backend and frontend components

.gitignore

@@ -0,0 +1,29 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+# build
+/build/
+
+# misc
+.DS_Store
+.env.production
+
+# debug
+npm-debug.log*
+
+.nyc_output
+coverage
+
+.env
+config.json
+database.sqlite
+
+package-lock.json
+pnpm-lock.yaml
+
+# Ponder
+/indexer/.ponder
+/indexer/generated
+yarn.lock

admin_frontend/.gitignore

@@ -21,3 +21,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+yarn.lock

admin_frontend/src/components/ApiKeys.jsx

@@ -135,12 +135,12 @@ const ApiKeysPage = () => {
           JSON.stringify(customErc20Paymaster)
         ).toString("base64");
       const requestData = {
-        API_KEY: apiKey,
-        PRIVATE_KEY: privateKey,
-        SUPPORTED_NETWORKS:
+        apiKey: apiKey,
+        privateKey: privateKey,
+        supportedNetworks:
           Buffer.from(JSON.stringify(supportedNetworks)).toString("base64") ??
           "",
-        ERC20_PAYMASTERS: base64Erc20 ?? "",
+          erc20Paymasters: base64Erc20 ?? "",
       };
       const data = await fetch(
         `${process.env.REACT_APP_SERVER_URL}${ENDPOINTS["saveKey"]}`,
@@ -280,12 +280,12 @@ const ApiKeysPage = () => {
               </TableCell>
             </TableRow>
             {keys.map((row, index) => (
-              <TableRow key={row.API_KEY}>
-                <TableCell>{row.WALLET_ADDRESS}</TableCell>
-                <TableCell>{row.API_KEY}</TableCell>
+              <TableRow key={row.apiKey}>
+                <TableCell>{row.walletAddress}</TableCell>
+                <TableCell>{row.apiKey}</TableCell>
                 <TableCell>
                   <div className="flex flex-row">
-                    <div>{showPassword ? row.PRIVATE_KEY : "*****"} </div>
+                    <div>{showPassword ? row.privateKey : "*****"} </div>
                     <div>
                       <InputAdornment position="end">
                         <IconButton
@@ -302,16 +302,16 @@ const ApiKeysPage = () => {
                 </TableCell>
                 <TableCell>
                   <Button
-                    disabled={row.SUPPORTED_NETWORKS === ""}
-                    onClick={() => handleViewOpen(row.SUPPORTED_NETWORKS)}
+                    disabled={row.supportedNetworks === ""}
+                    onClick={() => handleViewOpen(row.supportedNetworks)}
                   >
                     View
                   </Button>
                 </TableCell>
                 <TableCell>
                   <Button
-                    disabled={row.ERC20_PAYMASTERS === ""}
-                    onClick={() => handleViewERC20Open(row.ERC20_PAYMASTERS)}
+                    disabled={row.erc20Paymasters === ""}
+                    onClick={() => handleViewERC20Open(row.erc20Paymasters)}
                   >
                     View
                   </Button>
@@ -324,7 +324,7 @@ const ApiKeysPage = () => {
                     startIcon={<RemoveCircleIcon />}
                     variant="contained"
                     onClick={() => {
-                      handleDelete(row.API_KEY);
+                      handleDelete(row.apiKey);
                     }}
                   >
                     Delete Row

backend/.gitignore

@@ -25,4 +25,6 @@ pnpm-lock.yaml
 
 # Ponder
 /indexer/.ponder
-/indexer/generated
+/indexer/generated
+
+yarn.lock

backend/src/models/APIKey.ts

@@ -0,0 +1,86 @@
+import { Sequelize, DataTypes, Model } from 'sequelize';
+
+export class APIKey extends Model {
+  declare apiKey: string;
+  declare walletAddress: string;
+  declare privateKey: string;
+  declare supportedNetworks: string | null;
+  declare erc20Paymasters: string | null;
+  declare multiTokenPaymasters: string | null;
+  declare multiTokenOracles: string | null;
+  declare sponsorName: string | null;
+  declare logoUrl: string | null;
+  declare transactionLimit: number;
+  declare noOfTransactionsInAMonth: number | null;
+  declare indexerEndpoint: string | null;
+}
+
+export function initializeAPIKeyModel(sequelize: Sequelize) {
+  APIKey.init({
+    apiKey: {
+      type: DataTypes.TEXT,
+      allowNull: false,
+      primaryKey: true,
+      field: 'API_KEY'
+    },
+    walletAddress: {
+      type: DataTypes.TEXT,
+      allowNull: false,
+      field: 'WALLET_ADDRESS'
+    },
+    privateKey: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      field: 'PRIVATE_KEY'
+    },
+    supportedNetworks: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      field: 'SUPPORTED_NETWORKS'
+    },
+    erc20Paymasters: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      field: 'ERC20_PAYMASTERS'
+    },
+    multiTokenPaymasters: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      field: 'MULTI_TOKEN_PAYMASTERS'
+    },
+    multiTokenOracles: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      field: 'MULTI_TOKEN_ORACLES'
+    },
+    sponsorName: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      field: 'SPONSOR_NAME'
+    },
+    logoUrl: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      field: 'LOGO_URL'
+    },
+    transactionLimit: {
+      type: DataTypes.INTEGER,
+      allowNull: false,
+      field: 'TRANSACTION_LIMIT'
+    },
+    noOfTransactionsInAMonth: {
+      type: DataTypes.INTEGER,
+      allowNull: true,
+      field: 'NO_OF_TRANSACTIONS_IN_A_MONTH'
+    },
+    indexerEndpoint: {
+      type: DataTypes.STRING,
+      allowNull: true,
+      field: 'INDEXER_ENDPOINT'
+    },
+  }, {
+    tableName: 'api_keys',
+    sequelize, // passing the `sequelize` instance is required
+    timestamps: false, // this will deactivate the `createdAt` and `updatedAt` columns
+  });
+}

backend/src/plugins/sequelizePlugin.ts

@@ -0,0 +1,26 @@
+import fp from "fastify-plugin";
+import { FastifyPluginAsync } from "fastify";
+import { Sequelize } from 'sequelize';
+import sqlite3 from 'sqlite3';
+
+const sequelizePlugin: FastifyPluginAsync = async (server) => {
+    const sequelize = new Sequelize({
+        dialect: 'sqlite',
+        storage: './database.sqlite',
+        dialectModule: sqlite3
+    });
+
+    server.decorate('sequelize', sequelize);
+
+    server.addHook('onClose', (instance, done) => {
+        instance.sequelize.close().then(() => done(), done);
+    });
+};
+
+declare module "fastify" {
+    interface FastifyInstance {
+        sequelize: Sequelize;
+    }
+}
+
+export default fp(sequelizePlugin);

backend/src/repository/APIKeyRepository.ts

@@ -0,0 +1,25 @@
+import { Sequelize } from 'sequelize';
+import { APIKey } from '../models/APIKey';
+
+export class APIKeyRepository {
+  private sequelize: Sequelize;
+
+  constructor(sequelize: Sequelize) {
+    this.sequelize = sequelize;
+  }
+
+  async findAll(): Promise<APIKey[]> {
+    const result = await this.sequelize.models.APIKey.findAll();
+    return result.map(apiKey => apiKey.get() as APIKey);
+  }
+
+  async findOneByApiKey(apiKey: string): Promise<APIKey | null> {
+    const result = await this.sequelize.models.APIKey.findOne({ where: { apiKey: apiKey } });
+    return result ? result.get() as APIKey : null;
+  }
+
+  async findOneByWalletAddress(walletAddress: string): Promise<APIKey | null> {
+    const result = await this.sequelize.models.APIKey.findOne({ where: { walletAddress: walletAddress } });
+    return result ? result.get() as APIKey : null;
+  }
+}