Rename "locking" domain "community" (#1562)

Renames "locking" domain to "community" - the folder and all related components within it:

- `/src/domain/locking` -> `/src/domain/community`
- `ILockingRepository`-> `ICommunityRepository`
- `LockingRepository` -> `CommunityRepository`
- `LockingDomainModule` -> `CommunityDomainModule`

src/datasources/locking-api/locking-api.service.spec.ts

@@ -10,12 +10,12 @@ import {
   lockEventItemBuilder,
   unlockEventItemBuilder,
   withdrawEventItemBuilder,
-} from '@/domain/locking/entities/__tests__/locking-event.builder';
+} from '@/domain/community/entities/__tests__/locking-event.builder';
 import { getAddress } from 'viem';
-import { rankBuilder } from '@/domain/locking/entities/__tests__/rank.builder';
-import { campaignBuilder } from '@/domain/locking/entities/__tests__/campaign.builder';
-import { campaignRankBuilder } from '@/domain/locking/entities/__tests__/campaign-rank.builder';
-import { CampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
+import { rankBuilder } from '@/domain/community/entities/__tests__/rank.builder';
+import { campaignBuilder } from '@/domain/community/entities/__tests__/campaign.builder';
+import { campaignRankBuilder } from '@/domain/community/entities/__tests__/campaign-rank.builder';
+import { CampaignRank } from '@/domain/community/entities/campaign-rank.entity';
 
 const networkService = {
   get: jest.fn(),

src/datasources/locking-api/locking-api.service.ts

@@ -6,10 +6,10 @@ import {
 } from '@/datasources/network/network.service.interface';
 import { Page } from '@/domain/entities/page.entity';
 import { ILockingApi } from '@/domain/interfaces/locking-api.interface';
-import { Campaign } from '@/domain/locking/entities/campaign.entity';
-import { CampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
-import { LockingEvent } from '@/domain/locking/entities/locking-event.entity';
-import { Rank } from '@/domain/locking/entities/rank.entity';
+import { Campaign } from '@/domain/community/entities/campaign.entity';
+import { CampaignRank } from '@/domain/community/entities/campaign-rank.entity';
+import { LockingEvent } from '@/domain/community/entities/locking-event.entity';
+import { Rank } from '@/domain/community/entities/rank.entity';
 import { Inject } from '@nestjs/common';
 
 export class LockingApi implements ILockingApi {

src/domain/community/community.domain.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { LockingApiModule } from '@/datasources/locking-api/locking-api.module';
+import { ICommunityRepository } from '@/domain/community/community.repository.interface';
+import { CommunityRepository } from '@/domain/community/community.repository';
+
+@Module({
+  imports: [LockingApiModule],
+  providers: [{ provide: ICommunityRepository, useClass: CommunityRepository }],
+  exports: [ICommunityRepository],
+})
+export class CommunityDomainModule {}

src/domain/locking/locking.repository.interface.ts → src/domain/community/community.repository.interface.ts

@@ -1,12 +1,12 @@
 import { Page } from '@/domain/entities/page.entity';
-import { Campaign } from '@/domain/locking/entities/campaign.entity';
-import { CampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
-import { LockingEvent } from '@/domain/locking/entities/locking-event.entity';
-import { Rank } from '@/domain/locking/entities/rank.entity';
+import { Campaign } from '@/domain/community/entities/campaign.entity';
+import { CampaignRank } from '@/domain/community/entities/campaign-rank.entity';
+import { LockingEvent } from '@/domain/community/entities/locking-event.entity';
+import { Rank } from '@/domain/community/entities/rank.entity';
 
-export const ILockingRepository = Symbol('ILockingRepository');
+export const ICommunityRepository = Symbol('ICommunityRepository');
 
-export interface ILockingRepository {
+export interface ICommunityRepository {
   getCampaignById(campaignId: string): Promise<Campaign>;
 
   getCampaigns(args: {

src/domain/locking/locking.repository.ts → src/domain/community/community.repository.ts

@@ -4,23 +4,23 @@ import {
   Campaign,
   CampaignPageSchema,
   CampaignSchema,
-} from '@/domain/locking/entities/campaign.entity';
+} from '@/domain/community/entities/campaign.entity';
 import {
   CampaignRank,
   CampaignRankPageSchema,
-} from '@/domain/locking/entities/campaign-rank.entity';
-import { LockingEvent } from '@/domain/locking/entities/locking-event.entity';
-import { Rank } from '@/domain/locking/entities/rank.entity';
-import { LockingEventPageSchema } from '@/domain/locking/entities/schemas/locking-event.schema';
+} from '@/domain/community/entities/campaign-rank.entity';
+import { LockingEvent } from '@/domain/community/entities/locking-event.entity';
+import { Rank } from '@/domain/community/entities/rank.entity';
+import { LockingEventPageSchema } from '@/domain/community/entities/schemas/locking-event.schema';
 import {
   RankPageSchema,
   RankSchema,
-} from '@/domain/locking/entities/schemas/rank.schema';
-import { ILockingRepository } from '@/domain/locking/locking.repository.interface';
+} from '@/domain/community/entities/schemas/rank.schema';
+import { ICommunityRepository } from '@/domain/community/community.repository.interface';
 import { Inject, Injectable } from '@nestjs/common';
 
 @Injectable()
-export class LockingRepository implements ILockingRepository {
+export class CommunityRepository implements ICommunityRepository {
   constructor(
     @Inject(ILockingApi)
     private readonly lockingApi: ILockingApi,

src/domain/locking/entities/__tests__/activity-metadata.builder.ts → src/domain/community/entities/__tests__/activity-metadata.builder.ts

@@ -1,5 +1,5 @@
 import { Builder, IBuilder } from '@/__tests__/builder';
-import { ActivityMetadata } from '@/domain/locking/entities/activity-metadata.entity';
+import { ActivityMetadata } from '@/domain/community/entities/activity-metadata.entity';
 import { faker } from '@faker-js/faker';
 
 export function activityMetadataBuilder(): IBuilder<ActivityMetadata> {

src/domain/locking/entities/__tests__/campaign-rank.builder.ts → src/domain/community/entities/__tests__/campaign-rank.builder.ts

@@ -1,5 +1,5 @@
 import { Builder, IBuilder } from '@/__tests__/builder';
-import { CampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
+import { CampaignRank } from '@/domain/community/entities/campaign-rank.entity';
 import { faker } from '@faker-js/faker';
 import { getAddress } from 'viem';
 

src/domain/locking/entities/__tests__/campaign.builder.ts → src/domain/community/entities/__tests__/campaign.builder.ts

@@ -1,6 +1,6 @@
 import { IBuilder, Builder } from '@/__tests__/builder';
-import { activityMetadataBuilder } from '@/domain/locking/entities/__tests__/activity-metadata.builder';
-import { Campaign } from '@/domain/locking/entities/campaign.entity';
+import { activityMetadataBuilder } from '@/domain/community/entities/__tests__/activity-metadata.builder';
+import { Campaign } from '@/domain/community/entities/campaign.entity';
 import { faker } from '@faker-js/faker';
 
 export function campaignBuilder(): IBuilder<Campaign> {

src/domain/locking/entities/__tests__/locking-event.builder.ts → src/domain/community/entities/__tests__/locking-event.builder.ts

@@ -3,13 +3,13 @@ import {
   LockEventItem,
   UnlockEventItem,
   WithdrawEventItem,
-} from '@/domain/locking/entities/locking-event.entity';
+} from '@/domain/community/entities/locking-event.entity';
 import {
   LockEventItemSchema,
   LockingEventType,
   UnlockEventItemSchema,
   WithdrawEventItemSchema,
-} from '@/domain/locking/entities/schemas/locking-event.schema';
+} from '@/domain/community/entities/schemas/locking-event.schema';
 import { faker } from '@faker-js/faker';
 import { Hex, getAddress } from 'viem';
 import { z } from 'zod';

src/domain/locking/entities/__tests__/rank.builder.ts → src/domain/community/entities/__tests__/rank.builder.ts

@@ -1,5 +1,5 @@
 import { IBuilder, Builder } from '@/__tests__/builder';
-import { Rank } from '@/domain/locking/entities/rank.entity';
+import { Rank } from '@/domain/community/entities/rank.entity';
 import { faker } from '@faker-js/faker';
 import { getAddress } from 'viem';
 

src/domain/locking/entities/campaign.entity.ts → src/domain/community/entities/campaign.entity.ts

@@ -1,5 +1,5 @@
 import { buildPageSchema } from '@/domain/entities/schemas/page.schema.factory';
-import { ActivityMetadataSchema } from '@/domain/locking/entities/activity-metadata.entity';
+import { ActivityMetadataSchema } from '@/domain/community/entities/activity-metadata.entity';
 import { z } from 'zod';
 
 export type Campaign = z.infer<typeof CampaignSchema>;

src/domain/locking/entities/locking-event.entity.ts → src/domain/community/entities/locking-event.entity.ts

@@ -3,7 +3,7 @@ import {
   LockingEventSchema,
   UnlockEventItemSchema,
   WithdrawEventItemSchema,
-} from '@/domain/locking/entities/schemas/locking-event.schema';
+} from '@/domain/community/entities/schemas/locking-event.schema';
 import { z } from 'zod';
 
 export type LockEventItem = z.infer<typeof LockEventItemSchema>;

src/domain/community/entities/rank.entity.ts

@@ -0,0 +1,4 @@
+import { RankSchema } from '@/domain/community/entities/schemas/rank.schema';
+import { z } from 'zod';
+
+export type Rank = z.infer<typeof RankSchema>;

src/domain/locking/entities/schemas/__tests__/activity-metadata.schema.spec.ts → src/domain/community/entities/schemas/__tests__/activity-metadata.schema.spec.ts

@@ -1,5 +1,5 @@
-import { activityMetadataBuilder } from '@/domain/locking/entities/__tests__/activity-metadata.builder';
-import { ActivityMetadataSchema } from '@/domain/locking/entities/activity-metadata.entity';
+import { activityMetadataBuilder } from '@/domain/community/entities/__tests__/activity-metadata.builder';
+import { ActivityMetadataSchema } from '@/domain/community/entities/activity-metadata.entity';
 import { faker } from '@faker-js/faker';
 import { ZodError } from 'zod';
 

src/domain/locking/entities/schemas/__tests__/campaign-rank.schema.spec.ts → src/domain/community/entities/schemas/__tests__/campaign-rank.schema.spec.ts

@@ -1,5 +1,5 @@
-import { campaignRankBuilder } from '@/domain/locking/entities/__tests__/campaign-rank.builder';
-import { CampaignRankSchema } from '@/domain/locking/entities/campaign-rank.entity';
+import { campaignRankBuilder } from '@/domain/community/entities/__tests__/campaign-rank.builder';
+import { CampaignRankSchema } from '@/domain/community/entities/campaign-rank.entity';
 import { faker } from '@faker-js/faker';
 import { getAddress } from 'viem';
 import { ZodError } from 'zod';

src/domain/locking/entities/schemas/__tests__/campaign.schema.spec.ts → src/domain/community/entities/schemas/__tests__/campaign.schema.spec.ts

@@ -1,5 +1,5 @@
-import { campaignBuilder } from '@/domain/locking/entities/__tests__/campaign.builder';
-import { CampaignSchema } from '@/domain/locking/entities/campaign.entity';
+import { campaignBuilder } from '@/domain/community/entities/__tests__/campaign.builder';
+import { CampaignSchema } from '@/domain/community/entities/campaign.entity';
 import { faker } from '@faker-js/faker';
 import { ZodError } from 'zod';
 

src/domain/locking/entities/schemas/__tests__/locking-event.schema.spec.ts → src/domain/community/entities/schemas/__tests__/locking-event.schema.spec.ts

@@ -3,14 +3,14 @@ import {
   lockEventItemBuilder,
   unlockEventItemBuilder,
   withdrawEventItemBuilder,
-} from '@/domain/locking/entities/__tests__/locking-event.builder';
+} from '@/domain/community/entities/__tests__/locking-event.builder';
 import {
   LockEventItemSchema,
   LockingEventPageSchema,
   LockingEventSchema,
   UnlockEventItemSchema,
   WithdrawEventItemSchema,
-} from '@/domain/locking/entities/schemas/locking-event.schema';
+} from '@/domain/community/entities/schemas/locking-event.schema';
 import { faker } from '@faker-js/faker';
 import { getAddress } from 'viem';
 import { ZodError } from 'zod';

src/domain/locking/entities/schemas/__tests__/rank.schema.spec.ts → src/domain/community/entities/schemas/__tests__/rank.schema.spec.ts

@@ -1,5 +1,5 @@
-import { rankBuilder } from '@/domain/locking/entities/__tests__/rank.builder';
-import { RankSchema } from '@/domain/locking/entities/schemas/rank.schema';
+import { rankBuilder } from '@/domain/community/entities/__tests__/rank.builder';
+import { RankSchema } from '@/domain/community/entities/schemas/rank.schema';
 import { faker } from '@faker-js/faker';
 import { getAddress } from 'viem';
 import { ZodError } from 'zod';

src/domain/interfaces/locking-api.interface.ts

@@ -1,8 +1,8 @@
 import { Page } from '@/domain/entities/page.entity';
-import { Campaign } from '@/domain/locking/entities/campaign.entity';
-import { CampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
-import { LockingEvent } from '@/domain/locking/entities/locking-event.entity';
-import { Rank } from '@/domain/locking/entities/rank.entity';
+import { Campaign } from '@/domain/community/entities/campaign.entity';
+import { CampaignRank } from '@/domain/community/entities/campaign-rank.entity';
+import { LockingEvent } from '@/domain/community/entities/locking-event.entity';
+import { Rank } from '@/domain/community/entities/rank.entity';
 
 export const ILockingApi = Symbol('ILockingApi');
 

src/routes/community/community.controller.spec.ts

@@ -23,22 +23,22 @@ import {
   unlockEventItemBuilder,
   withdrawEventItemBuilder,
   toJson as lockingEventToJson,
-} from '@/domain/locking/entities/__tests__/locking-event.builder';
-import { LockingEvent } from '@/domain/locking/entities/locking-event.entity';
+} from '@/domain/community/entities/__tests__/locking-event.builder';
+import { LockingEvent } from '@/domain/community/entities/locking-event.entity';
 import { TestAccountDataSourceModule } from '@/datasources/account/__tests__/test.account.datasource.module';
 import { AccountDataSourceModule } from '@/datasources/account/account.datasource.module';
 import { getAddress } from 'viem';
-import { rankBuilder } from '@/domain/locking/entities/__tests__/rank.builder';
+import { rankBuilder } from '@/domain/community/entities/__tests__/rank.builder';
 import { PaginationData } from '@/routes/common/pagination/pagination.data';
 import { TestQueuesApiModule } from '@/datasources/queues/__tests__/test.queues-api.module';
 import { QueuesApiModule } from '@/datasources/queues/queues-api.module';
 import {
   campaignBuilder,
   toJson as campaignToJson,
-} from '@/domain/locking/entities/__tests__/campaign.builder';
-import { Campaign } from '@/domain/locking/entities/campaign.entity';
-import { CampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
-import { campaignRankBuilder } from '@/domain/locking/entities/__tests__/campaign-rank.builder';
+} from '@/domain/community/entities/__tests__/campaign.builder';
+import { Campaign } from '@/domain/community/entities/campaign.entity';
+import { CampaignRank } from '@/domain/community/entities/campaign-rank.entity';
+import { campaignRankBuilder } from '@/domain/community/entities/__tests__/campaign-rank.builder';
 
 describe('Community (Unit)', () => {
   let app: INestApplication;

src/routes/community/community.module.ts

@@ -1,10 +1,10 @@
 import { Module } from '@nestjs/common';
-import { LockingDomainModule } from '@/domain/locking/locking.domain.module';
+import { CommunityDomainModule } from '@/domain/community/community.domain.module';
 import { CommunityService } from '@/routes/community/community.service';
 import { CommunityController } from '@/routes/community/community.controller';
 
 @Module({
-  imports: [LockingDomainModule],
+  imports: [CommunityDomainModule],
   providers: [CommunityService],
   controllers: [CommunityController],
 })

src/routes/community/community.service.ts

@@ -1,9 +1,9 @@
 import { Page } from '@/domain/entities/page.entity';
-import { Campaign } from '@/domain/locking/entities/campaign.entity';
-import { CampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
-import { LockingEvent } from '@/domain/locking/entities/locking-event.entity';
-import { Rank } from '@/domain/locking/entities/rank.entity';
-import { ILockingRepository } from '@/domain/locking/locking.repository.interface';
+import { Campaign } from '@/domain/community/entities/campaign.entity';
+import { CampaignRank } from '@/domain/community/entities/campaign-rank.entity';
+import { LockingEvent } from '@/domain/community/entities/locking-event.entity';
+import { Rank } from '@/domain/community/entities/rank.entity';
+import { ICommunityRepository } from '@/domain/community/community.repository.interface';
 import {
   PaginationData,
   cursorUrlFromLimitAndOffset,
@@ -13,15 +13,15 @@ import { Inject, Injectable } from '@nestjs/common';
 @Injectable()
 export class CommunityService {
   constructor(
-    @Inject(ILockingRepository)
-    private readonly lockingRepository: ILockingRepository,
+    @Inject(ICommunityRepository)
+    private readonly communityRepository: ICommunityRepository,
   ) {}
 
   async getCampaigns(args: {
     routeUrl: URL;
     paginationData: PaginationData;
   }): Promise<Page<Campaign>> {
-    const result = await this.lockingRepository.getCampaigns(
+    const result = await this.communityRepository.getCampaigns(
       args.paginationData,
     );
 
@@ -40,15 +40,15 @@ export class CommunityService {
   }
 
   async getCampaignById(campaignId: string): Promise<Campaign> {
-    return this.lockingRepository.getCampaignById(campaignId);
+    return this.communityRepository.getCampaignById(campaignId);
   }
 
   async getCampaignLeaderboard(args: {
     campaignId: string;
     routeUrl: URL;
     paginationData: PaginationData;
   }): Promise<Page<CampaignRank>> {
-    const result = await this.lockingRepository.getCampaignLeaderboard({
+    const result = await this.communityRepository.getCampaignLeaderboard({
       campaignId: args.campaignId,
       limit: args.paginationData.limit,
       offset: args.paginationData.offset,
@@ -72,7 +72,7 @@ export class CommunityService {
     routeUrl: URL;
     paginationData: PaginationData;
   }): Promise<Page<Rank>> {
-    const result = await this.lockingRepository.getLeaderboard(
+    const result = await this.communityRepository.getLeaderboard(
       args.paginationData,
     );
 
@@ -91,15 +91,15 @@ export class CommunityService {
   }
 
   async getLockingRank(safeAddress: `0x${string}`): Promise<Rank> {
-    return this.lockingRepository.getRank(safeAddress);
+    return this.communityRepository.getRank(safeAddress);
   }
 
   async getLockingHistory(args: {
     safeAddress: `0x${string}`;
     routeUrl: URL;
     paginationData: PaginationData;
   }): Promise<Page<LockingEvent>> {
-    const result = await this.lockingRepository.getLockingHistory({
+    const result = await this.communityRepository.getLockingHistory({
       safeAddress: args.safeAddress,
       limit: args.paginationData.limit,
       offset: args.paginationData.offset,

src/routes/locking/entities/activity-metadata.entity.ts

@@ -1,4 +1,4 @@
-import { ActivityMetadata as DomainActivityMetadata } from '@/domain/locking/entities/activity-metadata.entity';
+import { ActivityMetadata as DomainActivityMetadata } from '@/domain/community/entities/activity-metadata.entity';
 import { ApiProperty } from '@nestjs/swagger';
 
 export class ActivityMetadata implements DomainActivityMetadata {

src/routes/locking/entities/campaign-rank.entity.ts

@@ -1,4 +1,4 @@
-import { CampaignRank as DomainCampaignRank } from '@/domain/locking/entities/campaign-rank.entity';
+import { CampaignRank as DomainCampaignRank } from '@/domain/community/entities/campaign-rank.entity';
 import { ApiProperty } from '@nestjs/swagger';
 
 export class CampaignRank implements DomainCampaignRank {

src/routes/locking/entities/campaign.entity.ts

@@ -1,4 +1,4 @@
-import { Campaign as DomainCampaign } from '@/domain/locking/entities/campaign.entity';
+import { Campaign as DomainCampaign } from '@/domain/community/entities/campaign.entity';
 import { ActivityMetadata } from '@/routes/locking/entities/activity-metadata.entity';
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 

src/routes/locking/entities/locking-event.page.entity.ts

@@ -2,8 +2,8 @@ import {
   LockEventItem as DomainLockEventItem,
   UnlockEventItem as DomainUnlockEventItem,
   WithdrawEventItem as DomainWithdrawEventItem,
-} from '@/domain/locking/entities/locking-event.entity';
-import { LockingEventType } from '@/domain/locking/entities/schemas/locking-event.schema';
+} from '@/domain/community/entities/locking-event.entity';
+import { LockingEventType } from '@/domain/community/entities/schemas/locking-event.schema';
 import { Page } from '@/routes/common/entities/page.entity';
 import { ApiExtraModels, ApiProperty, getSchemaPath } from '@nestjs/swagger';
 

src/routes/locking/entities/rank.entity.ts

@@ -1,4 +1,4 @@
-import { Rank as DomainRank } from '@/domain/locking/entities/rank.entity';
+import { Rank as DomainRank } from '@/domain/community/entities/rank.entity';
 import { ApiProperty } from '@nestjs/swagger';
 
 export class Rank implements DomainRank {