PRO-2949-Arka_Changes (#175)

vignesha22 · web-flow · commit 40a7202572e4 · 2025-02-12T13:53:20.000+05:30
diff --git a/backend/CHANGELOG.md b/backend/CHANGELOG.md
@@ -1,4 +1,16 @@
 # Changelog
+## [3.1.0] - 2025-01-28
+### New
+- Added a separate mode for all the common erc20 paymasters in mind that in future will replace the current erc20 mode
+
+## [3.0.3] - 2025-02-11
+### Fixes
+- Checked for undefined values on body params
+
+## [3.0.2] - 2025-02-11
+- Using Skandha for gas data for better transaction inclusion.
+- USE_SKANDHA_FOR_GAS_DATA set this property to false to disable.
+
 ## [3.0.1] - 2025-02-04
 ### Fixes
 - Changed error message to more meaningful reply
diff --git a/backend/migrations/2025012500001-create-MTP-table.cjs b/backend/migrations/2025012500001-create-MTP-table.cjs
@@ -0,0 +1,57 @@
+const { Sequelize } = require('sequelize')
+
+async function up({ context: queryInterface }) {
+  await queryInterface.createTable('multi_token_paymaster', {
+    ID: {
+      type: Sequelize.INTEGER,
+      primaryKey: true,
+      autoIncrement: true,
+      allowNull: false
+    },
+    TOKEN_ADDRESS: {
+      type: Sequelize.STRING,
+      allowNull: false,
+      primaryKey: true
+    },
+    PAYMASTER_ADDRESS: {
+      type: Sequelize.STRING,
+      allowNull: false
+    },
+    ORACLE_ADDRESS: {
+      type: Sequelize.STRING,
+      allowNull: true
+    },
+    CHAIN_ID: {
+      type: Sequelize.BIGINT,
+      allowNull: false,
+      get() {
+        const value = this.getDataValue('chainId');
+        return +value;
+      }
+    },
+    DECIMALS: {
+      type: Sequelize.INTEGER,
+      allowNull: false
+    },
+    CREATED_AT: {
+      type: Sequelize.DATE,
+      allowNull: false,
+      defaultValue: Sequelize.NOW
+    },
+    UPDATED_AT: {
+      type: Sequelize.DATE,
+      allowNull: false,
+      defaultValue: Sequelize.NOW
+    },
+  }, {
+    schema: process.env.DATABASE_SCHEMA_NAME
+  });
+}
+async function down({ context: queryInterface }) {
+  await queryInterface.dropTable({
+    tableName: 'multi_token_paymaster',
+    schema: process.env.DATABASE_SCHEMA_NAME
+  })
+}
+
+module.exports = { up, down }
diff --git a/backend/migrations/2025012500001-seed-data.cjs b/backend/migrations/2025012500001-seed-data.cjs
diff --git a/backend/package.json b/backend/package.json
@@ -1,6 +1,6 @@
 {
   "name": "arka",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "ARKA - (Albanian for Cashier's case) is the first open source Paymaster as a service software",
   "type": "module",
   "directories": {
diff --git a/backend/src/constants/ErrorMessage.ts b/backend/src/constants/ErrorMessage.ts
@@ -7,6 +7,7 @@ export default {
     API_KEY_NOT_CONFIGURED_IN_DATABASE: 'Api Key not configured in database',
     UNSUPPORTED_NETWORK: 'Unsupported network',
     UNSUPPORTED_NETWORK_TOKEN: 'Unsupported network/token',
+    UNSUPPORTED_TOKEN: 'Unsupported token',
     MISSING_PARAMS: 'You have not supplied the required input parameters for this function/endpoint',
     API_KEY_IS_REQUIRED_IN_HEADER: 'Api Key is required in header',
     API_KEY_DOES_NOT_EXIST_FOR_THE_WALLET_ADDRESS: 'Api Key does not exist for the wallet address',
@@ -52,6 +53,7 @@ export default {
     FAILED_TO_DEPLOY_VP: 'Failed to deploy verifying paymaster',
     FAILED_TO_ADD_STAKE: 'Failed to add stake',
     INVALID_AMOUNT_TO_STAKE: 'Invalid amount to stake',
+    NO_KEY_SET: 'No MTP key set',
     MULTI_NOT_DEPLOYED: 'Token Paymaster not deployed on the current chainID: ',
     COINGECKO_PRICE_NOT_FETCHED: 'Token price not updated, Pls retry.'
 }
diff --git a/backend/src/models/multiTokenPaymaster.ts b/backend/src/models/multiTokenPaymaster.ts
@@ -0,0 +1,77 @@
+import { Sequelize, DataTypes, Model } from 'sequelize';
+
+export class MultiTokenPaymaster extends Model {
+    public id!: number; // Note that the `null assertion` `!` is required in strict mode.
+    public tokenAddress!: string;
+    public oracleAddress!: string;
+    public paymasterAddress!: string;
+    public chainId!: number;
+    public decimals!: string;
+    public readonly createdAt!: Date;
+    public readonly updatedAt!: Date;
+}
+
+const initializeMTPModel = (sequelize: Sequelize, schema: string) => {
+  MultiTokenPaymaster.init({
+        id: {
+            type: DataTypes.INTEGER,
+            primaryKey: true,
+            autoIncrement: true,
+            allowNull: false,
+            field: 'ID'
+        },
+        tokenAddress: {
+          type: DataTypes.STRING,
+          allowNull: false,
+          primaryKey: true,
+          field: 'TOKEN_ADDRESS'
+        },
+        paymasterAddress: {
+          type: DataTypes.STRING,
+          allowNull: false,
+          field: 'PAYMASTER_ADDRESS'
+        },
+        oracleAddress: {
+          type: DataTypes.STRING,
+          allowNull: true,
+          field: 'ORACLE_ADDRESS'
+        },
+        chainId: {
+          type: DataTypes.BIGINT,
+          allowNull: false,
+          field: 'CHAIN_ID',
+          get() {
+            const value = this.getDataValue('chainId');
+            return +value;
+          }
+        },
+        decimals: {
+          type: DataTypes.INTEGER,
+          allowNull: false,
+          field: 'DECIMALS'
+        },
+        createdAt: {
+            type: DataTypes.DATE,
+            allowNull: false,
+            defaultValue: DataTypes.NOW,
+            field: 'CREATED_AT'
+        },
+        updatedAt: {
+            type: DataTypes.DATE,
+            allowNull: false,
+            defaultValue: DataTypes.NOW,
+            field: 'UPDATED_AT'
+        },
+    }, {
+        sequelize,
+        tableName: 'multi_token_paymaster',
+        modelName: 'MultiTokenPaymaster',
+        timestamps: true,
+        createdAt: 'createdAt',
+        updatedAt: 'updatedAt',
+        freezeTableName: true,
+        schema: schema,
+    });
+};
+
+export { initializeMTPModel };
diff --git a/backend/src/plugins/sequelizePlugin.ts b/backend/src/plugins/sequelizePlugin.ts
@@ -14,6 +14,9 @@ import { ContractWhitelistRepository } from "../repository/contract-whitelist-re
 import { initializeContractWhitelistModel } from "../models/contract-whitelist.js";
 import { CoingeckoTokensRepository } from "../repository/coingecko-token-repository.js";
 import { initializeCoingeckoModel } from "../models/coingecko.js";
+import { initializeMTPModel } from "../models/multiTokenPaymaster.js";
+import { MultiTokenPaymasterRepository } from "../repository/multi-token-paymaster.js";
+
 const pg = await import('pg');
 const Client = pg.default.Client;
 
@@ -58,6 +61,7 @@ const sequelizePlugin: FastifyPluginAsync = async (server) => {
     initializeArkaWhitelistModel(sequelize, server.config.DATABASE_SCHEMA_NAME);
     initializeContractWhitelistModel(sequelize, server.config.DATABASE_SCHEMA_NAME);
     initializeCoingeckoModel(sequelize, server.config.DATABASE_SCHEMA_NAME);
+    initializeMTPModel(sequelize, server.config.DATABASE_SCHEMA_NAME);
     server.log.info('Initialized SponsorshipPolicy model...');
 
     server.log.info('Initialized all models...');
@@ -76,6 +80,8 @@ const sequelizePlugin: FastifyPluginAsync = async (server) => {
     server.decorate('contractWhitelistRepository', contractWhitelistRepository);
     const coingeckoRepo: CoingeckoTokensRepository = new CoingeckoTokensRepository(sequelize);
     server.decorate('coingeckoRepo', coingeckoRepo);
+    const multiTokenPaymasterRepository: MultiTokenPaymasterRepository = new MultiTokenPaymasterRepository(sequelize);
+    server.decorate('multiTokenPaymasterRepository', multiTokenPaymasterRepository);
 
     server.log.info('decorated fastify server with models...');
 
@@ -94,6 +100,7 @@ declare module "fastify" {
         sponsorshipPolicyRepository: SponsorshipPolicyRepository;
         whitelistRepository: WhitelistRepository;
         contractWhitelistRepository: ContractWhitelistRepository;
+        multiTokenPaymasterRepository: MultiTokenPaymasterRepository;
     }
 }
 
diff --git a/backend/src/repository/multi-token-paymaster.ts b/backend/src/repository/multi-token-paymaster.ts
@@ -0,0 +1,46 @@
+import { Sequelize } from 'sequelize';
+import { MultiTokenPaymaster } from '../models/multiTokenPaymaster.js';
+
+export class MultiTokenPaymasterRepository {
+  private sequelize: Sequelize;
+
+  constructor(sequelize: Sequelize) {
+    this.sequelize = sequelize;
+  }
+
+  async findAll(): Promise<MultiTokenPaymaster[]> {
+    const result = await this.sequelize.models.MultiTokenPaymaster.findAll();
+    return result.map(id => id.get() as MultiTokenPaymaster);
+  }
+
+  async findOneByChainIdAndTokenAddress(chainId: number, tokenAddress: string): Promise<MultiTokenPaymaster | null> {
+    const result = await this.sequelize.models.MultiTokenPaymaster.findOne({
+      where: {
+        chainId: chainId, tokenAddress: tokenAddress
+      }
+    }) as MultiTokenPaymaster;
+
+    if (!result) {
+      return null;
+    }
+
+    return result.get() as MultiTokenPaymaster;
+  }
+
+  async findOneById(id: number): Promise<MultiTokenPaymaster | null> {
+    const multiTokenPaymaster = await this.sequelize.models.MultiTokenPaymaster.findOne({ where: { id: id } }) as MultiTokenPaymaster;
+    if (!multiTokenPaymaster) {
+      return null;
+    }
+
+    const dataValues = multiTokenPaymaster.get();
+    return dataValues as MultiTokenPaymaster;
+  }
+
+  async getAllDistinctPaymasterAddrWithChainId(): Promise<MultiTokenPaymaster[]> {
+    const result = await this.sequelize.models.MultiTokenPaymaster.findAll({
+      attributes: [[Sequelize.fn('DISTINCT', Sequelize.col('PAYMASTER_ADDRESS')), 'PAYMASTER_ADDRESS'], 'chainId'],
+    });
+    return result.map(id => id.get() as MultiTokenPaymaster);
+  }
+}
diff --git a/backend/src/routes/paymaster-routes.ts b/backend/src/routes/paymaster-routes.ts
@@ -394,6 +394,41 @@ const paymasterRoutes: FastifyPluginAsync<PaymasterRoutesOpts> = async (server,
               }
               break;
             }
+            case 'commonerc20': {
+              if (epVersion !== EPVersions.EPV_06)
+                throw new Error('Currently only EPV06 entryPoint address is supported')
+              const multiTokenRec = await server.multiTokenPaymasterRepository.findOneByChainIdAndTokenAddress(chainId, gasToken)
+              if (multiTokenRec) {
+                const date = new Date();
+                const provider = new providers.JsonRpcProvider(bundlerUrl);
+                const commonPrivateKey = process.env.MTP_PRIVATE_KEY;
+                if (!commonPrivateKey) return reply.code(ReturnCode.FAILURE).send({error: ErrorMessage.NO_KEY_SET})
+                const signer = new Wallet(commonPrivateKey, provider)
+                const validUntil = context.validUntil ? new Date(context.validUntil) : date;
+                const validAfter = context.validAfter ? new Date(context.validAfter) : date;
+                const hex = (Number((validUntil.valueOf() / 1000).toFixed(0)) + 600).toString(16);
+                const hex1 = (Number((validAfter.valueOf() / 1000).toFixed(0)) - 60).toString(16);
+                let str = '0x'
+                let str1 = '0x'
+                for (let i = 0; i < 14 - hex.length; i++) {
+                  str += '0';
+                }
+                for (let i = 0; i < 14 - hex1.length; i++) {
+                  str1 += '0';
+                }
+                str += hex;
+                str1 += hex1;
+                if (!networkConfig.MultiTokenPaymasterOracleUsed ||
+                  !(networkConfig.MultiTokenPaymasterOracleUsed == "orochi" || networkConfig.MultiTokenPaymasterOracleUsed == "chainlink" || networkConfig.MultiTokenPaymasterOracleUsed == "etherspotChainlink"))
+                  throw new Error("Oracle is not Defined/Invalid");
+                if (networkConfig.MultiTokenPaymasterOracleUsed == "chainlink" && !NativeOracles[chainId])
+                  throw new Error("Native Oracle address not set for this chainId")
+                result = await paymaster.signMultiTokenPaymaster(userOp, str, str1, entryPoint, multiTokenRec.paymasterAddress, gasToken, multiTokenRec.oracleAddress ?? '', bundlerUrl, signer, networkConfig.MultiTokenPaymasterOracleUsed, NativeOracles[chainId], chainId, server.log);
+              } else {
+                return reply.code(ReturnCode.FAILURE).send({ error: ErrorMessage.UNSUPPORTED_TOKEN })
+              }
+              break;
+            }
             default: {
               return reply.code(ReturnCode.FAILURE).send({ error: ErrorMessage.INVALID_MODE });
             }
diff --git a/backend/src/routes/pimlico-routes.ts b/backend/src/routes/pimlico-routes.ts
@@ -9,6 +9,7 @@ import ReturnCode from "../constants/ReturnCode.js";
 import { decode } from "../utils/crypto.js";
 import { printRequest, getNetworkConfig } from "../utils/common.js";
 import { APIKey } from "../models/api-key.js";
+import { ethers } from "ethers";
 
 const pimlicoRoutes: FastifyPluginAsync = async (server) => {
 
@@ -105,6 +106,42 @@ const pimlicoRoutes: FastifyPluginAsync = async (server) => {
         }
     )
 
+    server.post("/getAllCommonERC20PaymasterAddress",
+        ResponseSchema,
+        async function (request, reply) {
+            try {
+                printRequest("/getAllCommonERC20PaymasterAddress", request, server.log);
+                const query: any = request.query;
+                const body: any = request.body;
+                const entryPoint = body.params[0];
+                const api_key = query['apiKey'] ?? body.params[1];
+                if (!api_key || typeof(api_key) !== "string")
+                    return reply.code(ReturnCode.FAILURE).send({ error: ErrorMessage.INVALID_API_KEY })
+                if (!server.config.EPV_06.includes(entryPoint ?? '')) return reply.code(ReturnCode.FAILURE).send({ error: ErrorMessage.UNSUPPORTED_ENTRYPOINT })
+                const apiKeyData = await server.apiKeyRepository.findOneByApiKey(api_key);
+                if (!apiKeyData) return reply.code(ReturnCode.FAILURE).send({ error: ErrorMessage.INVALID_API_KEY })
+                const multiTokenRec = await server.multiTokenPaymasterRepository.findAll();
+                const result = multiTokenRec.map((record) => {
+                    return {
+                        paymasterAddress: record.paymasterAddress,
+                        gasToken: ethers.utils.getAddress(record.tokenAddress),
+                        chainId: record.chainId,
+                        decimals: record.decimals
+                    }
+                });
+                server.log.info(result, 'getAllCommonERC20PaymasterAddress Response sent: ');
+                if (body.jsonrpc)
+                    return reply.code(ReturnCode.SUCCESS).send({ jsonrpc: body.jsonrpc, id: body.id, message: JSON.stringify(result), error: null })
+                return reply.code(ReturnCode.SUCCESS).send({message: JSON.stringify(result)});
+            } catch (err: any) {
+                request.log.error(err);
+                if (err.name == "ResourceNotFoundException")
+                    return reply.code(ReturnCode.FAILURE).send({ error: ErrorMessage.INVALID_API_KEY });
+                return reply.code(ReturnCode.FAILURE).send({ error: err.message ?? ErrorMessage.FAILED_TO_PROCESS });
+            }
+        }
+    )
+
 };
 
 export default pimlicoRoutes;
diff --git a/backend/src/server.ts b/backend/src/server.ts
@@ -27,6 +27,7 @@ import { CoingeckoService } from './services/coingecko.js';
 import { CoingeckoTokensRepository } from './repository/coingecko-token-repository.js';
 import { Paymaster } from './paymaster/index.js';
 import { NativeOracles } from './constants/ChainlinkOracles.js';
+import { MultiTokenPaymaster } from './models/multiTokenPaymaster.js';
 
 let server: FastifyInstance;
 
@@ -305,6 +306,14 @@ const initializeServer = async (): Promise<void> => {
               for (const network of SupportedNetworks) {
                 checkDeposit(network.contracts.etherspotPaymasterAddress, network.bundler, process.env.WEBHOOK_URL, network.thresholdValue ?? '0.001', Number(network.chainId), server.log);
               }
+
+              // Checking of Deposit on common multi token paymaster if any
+              const result = await server.multiTokenPaymasterRepository.getAllDistinctPaymasterAddrWithChainId();
+              result.forEach((record: MultiTokenPaymaster) => {
+                const networkConfig = getNetworkConfig(record.chainId, '', server.config.EPV_06);
+                if (networkConfig)
+                  checkDeposit(ethers.utils.getAddress(record.paymasterAddress), networkConfig.bundler, process.env.WEBHOOK_URL ?? '', networkConfig.thresholdValue ?? '0.001', record.chainId, server.log);
+              })
             }
           } catch (err) {
             server.log.error(err);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "arka",`
`3`		`- "version": "3.0.1",`
	`3`	`+ "version": "3.1.0",`
`4`	`4`	`"description": "ARKA - (Albanian for Cashier's case) is the first open source Paymaster as a service software",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"directories": {`