refactor: Rename contractAddress to tokenAddress in Balance Subscriptions

- Update Prisma schema, migration, and database indexes
- Modify TypeScript interfaces and schemas across services and routes
- Ensure consistent naming for token-related address fields
- Update worker and database interaction methods

Author: d4mr

sdk/src/services/BalanceSubscriptionsService.ts

@@ -25,7 +25,7 @@ export class BalanceSubscriptionsService {
             /**
              * A contract or wallet address
              */
-            contractAddress?: string;
+            tokenAddress?: string;
             /**
              * A contract or wallet address
              */
@@ -76,7 +76,7 @@ export class BalanceSubscriptionsService {
             /**
              * A contract or wallet address
              */
-            contractAddress?: string;
+            tokenAddress?: string;
             /**
              * A contract or wallet address
              */
@@ -118,7 +118,7 @@ export class BalanceSubscriptionsService {
             /**
              * A contract or wallet address
              */
-            contractAddress?: string;
+            tokenAddress?: string;
             /**
              * A contract or wallet address
              */
@@ -172,7 +172,7 @@ export class BalanceSubscriptionsService {
              * A chain ID ("137") or slug ("polygon-amoy-testnet"). Chain ID is preferred.
              */
             chain?: string;
-            contractAddress?: (string | null);
+            tokenAddress?: (string | null);
             /**
              * A contract or wallet address
              */
@@ -201,7 +201,7 @@ export class BalanceSubscriptionsService {
             /**
              * A contract or wallet address
              */
-            contractAddress?: string;
+            tokenAddress?: string;
             /**
              * A contract or wallet address
              */

src/prisma/migrations/20250210081712_balance_subscriptions/migration.sql renamed to src/prisma/migrations/20250210192030_balance_subscriptions/migration.sql

@@ -5,7 +5,7 @@ ALTER TABLE "configuration" ADD COLUMN     "balanceSubscriptionsCronSchedule" TE
 CREATE TABLE "balance_subscriptions" (
     "id" TEXT NOT NULL,
     "chainId" TEXT NOT NULL,
-    "contractAddress" TEXT,
+    "tokenAddress" TEXT,
     "walletAddress" TEXT NOT NULL,
     "config" JSONB NOT NULL,
     "webhookId" INTEGER,
@@ -20,7 +20,7 @@ CREATE TABLE "balance_subscriptions" (
 CREATE INDEX "balance_subscriptions_chainId_idx" ON "balance_subscriptions"("chainId");
 
 -- CreateIndex
-CREATE INDEX "balance_subscriptions_contractAddress_idx" ON "balance_subscriptions"("contractAddress");
+CREATE INDEX "balance_subscriptions_tokenAddress_idx" ON "balance_subscriptions"("tokenAddress");
 
 -- CreateIndex
 CREATE INDEX "balance_subscriptions_walletAddress_idx" ON "balance_subscriptions"("walletAddress");

src/prisma/schema.prisma

@@ -290,10 +290,10 @@ model ContractEventLogs {
 }
 
 model BalanceSubscriptions {
-  id              String  @id @default(uuid())
-  chainId         String
-  contractAddress String? /// optional for ERC20 balances, if null then native balance
-  walletAddress   String
+  id            String  @id @default(uuid())
+  chainId       String
+  tokenAddress  String? /// optional for ERC20 balances, if null then native balance
+  walletAddress String
 
   config Json
 
@@ -305,7 +305,7 @@ model BalanceSubscriptions {
   deletedAt DateTime?
 
   @@index([chainId])
-  @@index([contractAddress])
+  @@index([tokenAddress])
   @@index([walletAddress])
   @@map("balance_subscriptions")
 }

src/server/routes/balance-subscriptions/add.ts

@@ -37,7 +37,7 @@ const webhookIdSchema = Type.Object({
 const requestBodySchema = Type.Intersect([
   Type.Object({
     chain: chainIdOrSlugSchema,
-    contractAddress: Type.Optional(AddressSchema),
+    tokenAddress: Type.Optional(AddressSchema),
     walletAddress: AddressSchema,
     config: balanceSubscriptionConfigSchema,
   }),
@@ -67,7 +67,7 @@ export async function addBalanceSubscriptionRoute(fastify: FastifyInstance) {
       },
     },
     handler: async (request, reply) => {
-      const { chain, contractAddress, walletAddress, config } = request.body;
+      const { chain, tokenAddress, walletAddress, config } = request.body;
       const chainId = await getChainIdFromChain(chain);
 
       let finalWebhookId: number | undefined;
@@ -121,7 +121,7 @@ export async function addBalanceSubscriptionRoute(fastify: FastifyInstance) {
       // Create the balance subscription
       const balanceSubscription = await createBalanceSubscription({
         chainId: chainId.toString(),
-        contractAddress: contractAddress?.toLowerCase(),
+        tokenAddress: tokenAddress?.toLowerCase(),
         walletAddress: walletAddress.toLowerCase(),
         config,
         webhookId: finalWebhookId,

src/server/routes/balance-subscriptions/update.ts

@@ -17,7 +17,7 @@ const requestBodySchema = Type.Object({
     description: "The ID of the balance subscription to update.",
   }),
   chain: Type.Optional(chainIdOrSlugSchema),
-  contractAddress: Type.Optional(Type.Union([AddressSchema, Type.Null()])),
+  tokenAddress: Type.Optional(Type.Union([AddressSchema, Type.Null()])),
   walletAddress: Type.Optional(AddressSchema),
   config: Type.Optional(balanceSubscriptionConfigSchema),
   webhookId: Type.Optional(
@@ -56,7 +56,7 @@ export async function updateBalanceSubscriptionRoute(fastify: FastifyInstance) {
       const {
         balanceSubscriptionId,
         chain,
-        contractAddress,
+        tokenAddress,
         walletAddress,
         config,
         webhookId,
@@ -69,7 +69,7 @@ export async function updateBalanceSubscriptionRoute(fastify: FastifyInstance) {
       const balanceSubscription = await updateBalanceSubscription({
         id: balanceSubscriptionId,
         chainId: chainId?.toString(),
-        contractAddress,
+        tokenAddress,
         walletAddress,
         config,
         webhookId,

src/server/schemas/balance-subscription.ts

@@ -7,19 +7,20 @@ import { balanceSubscriptionConfigSchema, balanceSubscriptionConfigZodSchema } f
 interface BalanceSubscriptionWithWebhook {
   id: string;
   chainId: string;
-  contractAddress: string | null;
+  tokenAddress: string | null;
   walletAddress: string;
   config: Prisma.JsonValue;
   webhookId: number | null;
   webhook: Webhooks | null;
   createdAt: Date;
   updatedAt: Date;
+  deletedAt: Date | null;
 }
 
 export const balanceSubscriptionSchema = Type.Object({
   id: Type.String(),
   chain: chainIdOrSlugSchema,
-  contractAddress: Type.Optional(AddressSchema),
+  tokenAddress: Type.Optional(AddressSchema),
   walletAddress: AddressSchema,
   config: balanceSubscriptionConfigSchema,
   webhook: Type.Optional(
@@ -37,7 +38,7 @@ export function toBalanceSubscriptionSchema(subscription: BalanceSubscriptionWit
   return {
     id: subscription.id,
     chain: subscription.chainId,
-    contractAddress: subscription.contractAddress ?? undefined,
+    tokenAddress: subscription.tokenAddress ?? undefined,
     walletAddress: subscription.walletAddress,
     config: balanceSubscriptionConfigZodSchema.parse(subscription.config),
     webhook: subscription.webhookId && subscription.webhook

src/shared/db/balance-subscriptions/create-balance-subscription.ts

@@ -4,15 +4,15 @@ import type { BalanceSubscriptionConfig } from "../../schemas/balance-subscripti
 
 interface CreateBalanceSubscriptionParams {
   chainId: string;
-  contractAddress?: string;
+  tokenAddress?: string;
   walletAddress: string;
   config: BalanceSubscriptionConfig;
   webhookId?: number;
 }
 
 export async function createBalanceSubscription({
   chainId,
-  contractAddress,
+  tokenAddress,
   walletAddress,
   config,
   webhookId,
@@ -21,7 +21,7 @@ export async function createBalanceSubscription({
   const existingSubscription = await prisma.balanceSubscriptions.findFirst({
     where: {
       chainId,
-      contractAddress,
+      tokenAddress,
       walletAddress,
       deletedAt: null,
     },
@@ -47,7 +47,7 @@ export async function createBalanceSubscription({
   return await prisma.balanceSubscriptions.create({
     data: {
       chainId,
-      contractAddress,
+      tokenAddress,
       walletAddress,
       config: config as Prisma.InputJsonValue,
       webhookId,

src/shared/db/balance-subscriptions/update-balance-subscription.ts

@@ -5,7 +5,7 @@ import type { BalanceSubscriptionConfig } from "../../schemas/balance-subscripti
 interface UpdateBalanceSubscriptionParams {
   id: string;
   chainId?: string;
-  contractAddress?: string | null;
+  tokenAddress?: string | null;
   walletAddress?: string;
   config?: BalanceSubscriptionConfig;
   webhookId?: number | null;
@@ -14,7 +14,7 @@ interface UpdateBalanceSubscriptionParams {
 export async function updateBalanceSubscription({
   id,
   chainId,
-  contractAddress,
+  tokenAddress,
   walletAddress,
   config,
   webhookId,
@@ -26,7 +26,7 @@ export async function updateBalanceSubscription({
     },
     data: {
       ...(chainId && { chainId }),
-      ...(contractAddress !== undefined && { contractAddress }),
+      ...(tokenAddress !== undefined && { tokenAddress }),
       ...(walletAddress && { walletAddress: walletAddress.toLowerCase() }),
       ...(config && { config: config as Prisma.InputJsonValue }),
       ...(webhookId !== undefined && { webhookId }),

src/shared/schemas/webhooks.ts

@@ -25,7 +25,7 @@ export type BackendWalletBalanceWebhookParams = {
 export interface BalanceSubscriptionWebhookParams {
   subscriptionId: string;
   chainId: string;
-  contractAddress: string | null;
+  tokenAddress: string | null;
   walletAddress: string;
   balance: string;
   config: z.infer<typeof balanceSubscriptionConfigZodSchema>;

src/worker/tasks/balance-subscription-worker.ts

@@ -70,7 +70,7 @@ const handler: Processor<string, void, string> = async (job: Job<string>) => {
           const currentBalanceResponse = await getWalletBalance({
             address: subscription.walletAddress,
             client: thirdwebClient,
-            tokenAddress: subscription.contractAddress ?? undefined, // get ERC20 balance if contract address is provided
+            tokenAddress: subscription.tokenAddress ?? undefined, // get ERC20 balance if token address is provided
             chain,
           });
 
@@ -92,7 +92,7 @@ const handler: Processor<string, void, string> = async (job: Job<string>) => {
             const webhookBody: BalanceSubscriptionWebhookParams = {
               subscriptionId: subscription.id,
               chainId: subscription.chainId,
-              contractAddress: subscription.contractAddress,
+              tokenAddress: subscription.tokenAddress,
               walletAddress: subscription.walletAddress,
               balance: currentBalance.toString(),
               config: parseBalanceSubscriptionConfig(subscription.config),