Update: Contract-Write Accepts Contract ABI (#534)

* Update: Contract-Write Accepts Contract ABI

* updated abiSchema

Author: farhanW3

src/server/routes/contract/write/write.ts

@@ -3,6 +3,7 @@ import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { queueTx } from "../../../../db/transactions/queueTx";
 import { getContract } from "../../../../utils/cache/getContract";
+import { abiSchema } from "../../../schemas/contract";
 import {
   contractParamSchema,
   requestQuerystringSchema,
@@ -30,20 +31,9 @@ const writeRequestBodySchema = Type.Object({
     ]),
   ),
   ...txOverrides.properties,
+  abi: Type.Array(abiSchema),
 });
 
-// Adding example for Swagger File
-writeRequestBodySchema.examples = [
-  {
-    functionName: "transferFrom",
-    args: [
-      "0x1946267d81Fb8aDeeEa28e6B98bcD446c8248473",
-      "0x3EcDBF3B911d0e9052b64850693888b008e18373",
-      "0",
-    ],
-  },
-];
-
 // LOGIC
 export async function writeToContract(fastify: FastifyInstance) {
   fastify.route<{
@@ -71,7 +61,7 @@ export async function writeToContract(fastify: FastifyInstance) {
     handler: async (request, reply) => {
       const { chain, contractAddress } = request.params;
       const { simulateTx } = request.query;
-      const { functionName, args, txOverrides } = request.body;
+      const { functionName, args, txOverrides, abi } = request.body;
       const {
         "x-backend-wallet-address": walletAddress,
         "x-account-address": accountAddress,
@@ -84,6 +74,7 @@ export async function writeToContract(fastify: FastifyInstance) {
         contractAddress,
         walletAddress,
         accountAddress,
+        abi,
       });
       const tx = contract.prepare(functionName, args, {
         value: txOverrides?.value,

src/server/schemas/contract/index.ts

@@ -54,8 +54,9 @@ export const abiEventSchema = Type.Object({
 
 export const abiSchema = Type.Object({
   type: Type.String(),
-  name: Type.String(),
+  name: Type.Optional(Type.String()),
   inputs: Type.Array(abiTypeSchema),
+  stateMutability: Type.Optional(Type.String()),
 });
 
 export const contractEventSchema = Type.Record(Type.String(), Type.Any());

src/utils/cache/getContract.ts

@@ -1,23 +1,32 @@
+import { Static, Type } from "@sinclair/typebox";
 import { StatusCodes } from "http-status-codes";
 import { createCustomError } from "../../server/middleware/error";
+import { abiSchema } from "../../server/schemas/contract";
 import { getSdk } from "./getSdk";
 
+const abiArraySchema = Type.Array(abiSchema);
+
 interface GetContractParams {
   chainId: number;
   walletAddress?: string;
   accountAddress?: string;
   contractAddress: string;
+  abi?: Static<typeof abiArraySchema>;
 }
 
 export const getContract = async ({
   chainId,
   walletAddress,
   contractAddress,
   accountAddress,
+  abi,
 }: GetContractParams) => {
   const sdk = await getSdk({ chainId, walletAddress, accountAddress });
 
   try {
+    if (abi) {
+      return sdk.getContractFromAbi(contractAddress, abi);
+    }
     // SDK already handles caching.
     return await sdk.getContract(contractAddress);
   } catch (e) {