feat: add new gelato_getStatus endpoint (#9)

* feat: add Gelato status handling to EVM relayer

- Introduced `getGelatoStatus` and `waitForGelatoStatus` actions for querying and waiting on Gelato transaction statuses.
- Updated `GelatoEvmRelayerClient` to include new methods for Gelato status retrieval.
- Added schemas for Gelato status and terminal status using Zod for validation.

* feat: add gelato_getStatus endpoint

- Introduced a new endpoint for retrieving Gelato transaction statuses.
- Updated the changeset to reflect the patch for "@gelatocloud/gasless".

Author: denispanov

.changeset/sixty-hats-boil.md

@@ -0,0 +1,5 @@
+---
+"@gelatocloud/gasless": patch
+---
+
+added new gelato_getStatus endpoint

src/relayer/evm/actions/getGelatoStatus.ts

@@ -0,0 +1,99 @@
+import type { Transport } from 'viem';
+import { z } from 'zod';
+import { evmAddressSchema, hexData32Schema, hexDataSchema } from '../../../types/index.js';
+
+export enum GelatoStatusCode {
+  Pending = 100,
+  Submitted = 110,
+  Included = 200,
+  Finalized = 210,
+  Rejected = 400,
+  Reverted = 500
+}
+
+const logSchema = z.object({
+  address: evmAddressSchema,
+  data: hexDataSchema,
+  topics: z.array(hexData32Schema)
+});
+
+const receiptSchema = z.object({
+  blockHash: hexData32Schema,
+  blockNumber: z.coerce.bigint(),
+  gasUsed: z.coerce.bigint(),
+  logs: z.array(logSchema).optional(),
+  transactionHash: hexData32Schema
+});
+
+const baseStatusSchema = z.object({
+  chainId: z.coerce.number(),
+  createdAt: z.number()
+});
+
+const pendingStatusSchema = baseStatusSchema.extend({
+  status: z.literal(GelatoStatusCode.Pending)
+});
+
+const submittedStatusSchema = baseStatusSchema.extend({
+  hash: hexData32Schema,
+  status: z.literal(GelatoStatusCode.Submitted)
+});
+
+const includedStatusSchema = baseStatusSchema.extend({
+  receipt: receiptSchema,
+  status: z.literal(GelatoStatusCode.Included)
+});
+
+const finalizedStatusSchema = baseStatusSchema.extend({
+  receipt: receiptSchema,
+  status: z.literal(GelatoStatusCode.Finalized)
+});
+
+const rejectedStatusSchema = baseStatusSchema.extend({
+  data: z.unknown().optional(),
+  message: z.string(),
+  status: z.literal(GelatoStatusCode.Rejected)
+});
+
+const revertedStatusSchema = baseStatusSchema.extend({
+  data: z.string(),
+  message: z.string().optional(),
+  status: z.literal(GelatoStatusCode.Reverted)
+});
+
+export const gelatoTerminalStatusSchema = z.discriminatedUnion('status', [
+  finalizedStatusSchema,
+  rejectedStatusSchema,
+  revertedStatusSchema
+]);
+
+export const gelatoStatusSchema = z.discriminatedUnion('status', [
+  pendingStatusSchema,
+  submittedStatusSchema,
+  includedStatusSchema,
+  finalizedStatusSchema,
+  rejectedStatusSchema,
+  revertedStatusSchema
+]);
+
+export type GelatoTerminalStatus = z.infer<typeof gelatoTerminalStatusSchema>;
+
+export type GelatoStatus = z.infer<typeof gelatoStatusSchema>;
+
+export type GetGelatoStatusParameters = {
+  id: string;
+};
+
+export const getGelatoStatus = async (
+  client: ReturnType<Transport>,
+  parameters: GetGelatoStatusParameters
+): Promise<GelatoStatus> => {
+  const { id } = parameters;
+
+  const result = await client.request({
+    method: 'gelato_getStatus',
+    params: { id }
+  });
+
+  return gelatoStatusSchema.parse(result);
+};

src/relayer/evm/actions/index.ts

@@ -1,7 +1,9 @@
 export * from './getCapabilities.js';
 export * from './getFeeData.js';
 export * from './getFeeQuote.js';
+export * from './getGelatoStatus.js';
 export * from './getStatus.js';
 export * from './sendTransaction.js';
 export * from './sendTransactionSync.js';
+export * from './waitForGelatoStatus.js';
 export * from './waitForStatus.js';

src/relayer/evm/actions/waitForGelatoStatus.ts

@@ -0,0 +1,28 @@
+import type { Transport } from 'viem';
+import {
+  GelatoStatusCode,
+  type GelatoTerminalStatus,
+  type GetGelatoStatusParameters,
+  getGelatoStatus
+} from './getGelatoStatus.js';
+
+// TODO: use websockets
+// TODO: make polling interval configurable
+export const waitForGelatoStatus = async (
+  client: ReturnType<Transport>,
+  parameters: GetGelatoStatusParameters
+): Promise<GelatoTerminalStatus> => {
+  while (true) {
+    const status = await getGelatoStatus(client, parameters);
+
+    if (
+      status.status !== GelatoStatusCode.Pending &&
+      status.status !== GelatoStatusCode.Submitted &&
+      status.status !== GelatoStatusCode.Included
+    ) {
+      return status;
+    }
+
+    await new Promise((r) => setTimeout(r, 100));
+  }
+};

src/relayer/evm/index.ts

@@ -4,19 +4,24 @@ import {
   type Capabilities,
   type FeeData,
   type FeeQuote,
+  type GelatoStatus,
+  type GelatoTerminalStatus,
   type GetFeeDataParameters,
   type GetFeeQuoteParameters,
+  type GetGelatoStatusParameters,
   type GetStatusParameters,
   getCapabilities,
   getFeeData,
   getFeeQuote,
+  getGelatoStatus,
   getStatus,
   type SendTransactionParameters,
   type SendTransactionSyncParameters,
   type Status,
   sendTransaction,
   sendTransactionSync,
   type TerminalStatus,
+  waitForGelatoStatus,
   waitForStatus
 } from './actions/index.js';
 
@@ -26,7 +31,9 @@ export type GelatoEvmRelayerClient = {
   getCapabilities: () => Promise<Capabilities>;
   getFeeData: (parameters: GetFeeDataParameters) => Promise<FeeData>;
   getFeeQuote: (parameters: GetFeeQuoteParameters) => Promise<FeeQuote>;
+  getGelatoStatus: (parameters: GetGelatoStatusParameters) => Promise<GelatoStatus>;
   getStatus: (parameters: GetStatusParameters) => Promise<Status>;
+  waitForGelatoStatus: (parameters: GetGelatoStatusParameters) => Promise<GelatoTerminalStatus>;
   waitForStatus: (parameters: GetStatusParameters) => Promise<TerminalStatus>;
   sendTransaction: (parameters: SendTransactionParameters) => Promise<Hex>;
   sendTransactionSync: (parameters: SendTransactionSyncParameters) => Promise<TerminalStatus>;
@@ -60,9 +67,11 @@ export const createGelatoEvmRelayerClient = (
     getCapabilities: () => getCapabilities(client),
     getFeeData: (parameters) => getFeeData(client, parameters),
     getFeeQuote: (parameters) => getFeeQuote(client, parameters),
+    getGelatoStatus: (parameters) => getGelatoStatus(client, parameters),
     getStatus: (parameters) => getStatus(client, parameters),
     sendTransaction: (parameters) => sendTransaction(client, parameters),
     sendTransactionSync: (parameters) => sendTransactionSync(client, parameters),
+    waitForGelatoStatus: (parameters) => waitForGelatoStatus(client, parameters),
     waitForStatus: (parameters) => waitForStatus(client, parameters)
   };
 };