Map beaconChainExplorerUriTemplate property

src/domain/chains/entities/__tests__/beacon-chain-explorer-uri-template.builder.ts

@@ -0,0 +1,11 @@
+import { faker } from '@faker-js/faker';
+import { Builder, IBuilder } from '@/__tests__/builder';
+import { BeaconChainExplorerUriTemplate } from '@/domain/chains/entities/beacon-chain-explorer-uri-template.entity';
+
+export function beaconChainExplorerUriTemplateBuilder(): IBuilder<BeaconChainExplorerUriTemplate> {
+  const explorerUrl = faker.internet.url({ appendSlash: false });
+  return new Builder<BeaconChainExplorerUriTemplate>().with(
+    'publicKey',
+    `${explorerUrl}/{{publicKey}}`,
+  );
+}

src/domain/chains/entities/__tests__/chain.builder.ts

@@ -11,6 +11,7 @@ import { Chain } from '@/domain/chains/entities/chain.entity';
 import { pricesProviderBuilder } from '@/domain/chains/entities/__tests__/prices-provider.builder';
 import { balancesProviderBuilder } from '@/domain/chains/entities/__tests__/balances-provider.builder';
 import { contractAddressesBuilder } from '@/domain/chains/entities/__tests__/contract-addresses.builder';
+import { beaconChainExplorerUriTemplateBuilder } from '@/domain/chains/entities/__tests__/beacon-chain-explorer-uri-template.builder';
 
 export function chainBuilder(): IBuilder<Chain> {
   return new Builder<Chain>()
@@ -25,6 +26,10 @@ export function chainBuilder(): IBuilder<Chain> {
     .with('safeAppsRpcUri', rpcUriBuilder().build())
     .with('publicRpcUri', rpcUriBuilder().build())
     .with('blockExplorerUriTemplate', blockExplorerUriTemplateBuilder().build())
+    .with(
+      'beaconChainExplorerUriTemplate',
+      beaconChainExplorerUriTemplateBuilder().build(),
+    )
     .with('nativeCurrency', nativeCurrencyBuilder().build())
     .with('pricesProvider', pricesProviderBuilder().build())
     .with('balancesProvider', balancesProviderBuilder().build())

src/domain/chains/entities/beacon-chain-explorer-uri-template.entity.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+import { BeaconChainExplorerUriTemplateSchema } from '@/domain/chains/entities/schemas/chain.schema';
+
+export type BeaconChainExplorerUriTemplate = z.infer<
+  typeof BeaconChainExplorerUriTemplateSchema
+>;

src/domain/chains/entities/schemas/__tests__/chain.schema.spec.ts

@@ -1,4 +1,5 @@
 import { balancesProviderBuilder } from '@/domain/chains/entities/__tests__/balances-provider.builder';
+import { beaconChainExplorerUriTemplateBuilder } from '@/domain/chains/entities/__tests__/beacon-chain-explorer-uri-template.builder';
 import { chainBuilder } from '@/domain/chains/entities/__tests__/chain.builder';
 import { contractAddressesBuilder } from '@/domain/chains/entities/__tests__/contract-addresses.builder';
 import { gasPriceFixedEIP1559Builder } from '@/domain/chains/entities/__tests__/gas-price-fixed-eip-1559.builder';
@@ -22,6 +23,7 @@ import {
   ThemeSchema,
   ContractAddressesSchema,
   ChainLenientPageSchema,
+  BeaconChainExplorerUriTemplateSchema,
 } from '@/domain/chains/entities/schemas/chain.schema';
 import { pageBuilder } from '@/domain/entities/__tests__/page.builder';
 import { faker } from '@faker-js/faker';
@@ -116,6 +118,73 @@ describe('Chain schemas', () => {
     });
   });
 
+  describe('BeaconChainExplorerUriTemplate', () => {
+    it('should validate a BeaconChainExplorerUriTemplate', () => {
+      const beaconChainExplorerUriTemplate =
+        beaconChainExplorerUriTemplateBuilder().build();
+
+      const result = BeaconChainExplorerUriTemplateSchema.safeParse(
+        beaconChainExplorerUriTemplate,
+      );
+
+      expect(result.success).toBe(true);
+    });
+
+    it('should allow a string publicKey', () => {
+      const beaconChainExplorerUriTemplate =
+        beaconChainExplorerUriTemplateBuilder()
+          .with(
+            'publicKey',
+            `${faker.internet.url({ appendSlash: false })}/{{publicKey}}`,
+          )
+          .build();
+
+      const result = BeaconChainExplorerUriTemplateSchema.safeParse(
+        beaconChainExplorerUriTemplate,
+      );
+
+      expect(result.success).toBe(true);
+    });
+
+    it('should allow a null publicKey', () => {
+      const beaconChainExplorerUriTemplate =
+        beaconChainExplorerUriTemplateBuilder().with('publicKey', null).build();
+
+      const result = BeaconChainExplorerUriTemplateSchema.safeParse(
+        beaconChainExplorerUriTemplate,
+      );
+
+      expect(result.success).toBe(true);
+    });
+
+    it('should default publicKey to null', () => {
+      const beaconChainExplorerUriTemplate = {
+        publicKey: null,
+      };
+
+      const result = BeaconChainExplorerUriTemplateSchema.safeParse(
+        beaconChainExplorerUriTemplate,
+      );
+
+      expect(result.success && result.data.publicKey).toBe(null);
+    });
+
+    // TODO: Remove after `beaconChainExplorerUriTemplate` field is deployed on Config Service
+    it('should default beaconChainExplorerUriTemplate to have null publicKey', () => {
+      const chain = chainBuilder().build();
+      // @ts-expect-error - inferred types don't allow optional fields
+      delete chain.beaconChainExplorerUriTemplate;
+
+      const result = ChainSchema.safeParse(chain);
+
+      expect(
+        result.success && result.data.beaconChainExplorerUriTemplate,
+      ).toStrictEqual({
+        publicKey: null,
+      });
+    });
+  });
+
   describe('ThemeSchema', () => {
     it('should validate a valid theme', () => {
       const theme = themeBuilder().build();
@@ -606,6 +675,8 @@ describe('Chain schemas', () => {
       ['safeAppsRpcUri' as const],
       ['publicRpcUri' as const],
       ['blockExplorerUriTemplate' as const],
+      // TODO: Include after `beaconChainExplorerUriTemplate` field is deployed on Config Service
+      // ['beaconChainExplorerUriTemplate' as const],
       ['nativeCurrency' as const],
       ['pricesProvider' as const],
       ['balancesProvider' as const],

src/domain/chains/entities/schemas/chain.schema.ts

@@ -23,6 +23,15 @@ export const BlockExplorerUriTemplateSchema = z.object({
   api: z.string(),
 });
 
+export const BeaconChainExplorerUriTemplateSchema = z
+  .object({
+    publicKey: z.string().nullish().default(null),
+  })
+  // TODO: Remove after `beaconChainExplorerUriTemplate` field is deployed on Config Service
+  .catch({
+    publicKey: null,
+  });
+
 export const ThemeSchema = z.object({
   textColor: z.string(),
   backgroundColor: z.string(),
@@ -105,6 +114,7 @@ export const ChainSchema = z.object({
   safeAppsRpcUri: RpcUriSchema,
   publicRpcUri: RpcUriSchema,
   blockExplorerUriTemplate: BlockExplorerUriTemplateSchema,
+  beaconChainExplorerUriTemplate: BeaconChainExplorerUriTemplateSchema,
   contractAddresses: ContractAddressesSchema,
   nativeCurrency: NativeCurrencySchema,
   pricesProvider: PricesProviderSchema,

src/routes/chains/chains.controller.spec.ts

@@ -122,6 +122,8 @@ describe('Chains Controller (Unit)', () => {
               publicRpcUri: chainsResponse.results[0].publicRpcUri,
               blockExplorerUriTemplate:
                 chainsResponse.results[0].blockExplorerUriTemplate,
+              beaconChainExplorerUriTemplate:
+                chainsResponse.results[0].beaconChainExplorerUriTemplate,
               nativeCurrency: chainsResponse.results[0].nativeCurrency,
               transactionService: chainsResponse.results[0].transactionService,
               theme: chainsResponse.results[0].theme,
@@ -147,6 +149,8 @@ describe('Chains Controller (Unit)', () => {
               publicRpcUri: chainsResponse.results[1].publicRpcUri,
               blockExplorerUriTemplate:
                 chainsResponse.results[1].blockExplorerUriTemplate,
+              beaconChainExplorerUriTemplate:
+                chainsResponse.results[1].beaconChainExplorerUriTemplate,
               nativeCurrency: chainsResponse.results[1].nativeCurrency,
               transactionService: chainsResponse.results[1].transactionService,
               theme: chainsResponse.results[1].theme,
@@ -233,6 +237,8 @@ describe('Chains Controller (Unit)', () => {
               publicRpcUri: chainsResponse.results[0].publicRpcUri,
               blockExplorerUriTemplate:
                 chainsResponse.results[0].blockExplorerUriTemplate,
+              beaconChainExplorerUriTemplate:
+                chainsResponse.results[0].beaconChainExplorerUriTemplate,
               nativeCurrency: chainsResponse.results[0].nativeCurrency,
               transactionService: chainsResponse.results[0].transactionService,
               theme: chainsResponse.results[0].theme,
@@ -258,6 +264,8 @@ describe('Chains Controller (Unit)', () => {
               publicRpcUri: chainsResponse.results[1].publicRpcUri,
               blockExplorerUriTemplate:
                 chainsResponse.results[1].blockExplorerUriTemplate,
+              beaconChainExplorerUriTemplate:
+                chainsResponse.results[1].beaconChainExplorerUriTemplate,
               nativeCurrency: chainsResponse.results[1].nativeCurrency,
               transactionService: chainsResponse.results[1].transactionService,
               theme: chainsResponse.results[1].theme,
@@ -325,6 +333,8 @@ describe('Chains Controller (Unit)', () => {
         nativeCurrency: chainDomain.nativeCurrency,
         transactionService: chainDomain.transactionService,
         blockExplorerUriTemplate: chainDomain.blockExplorerUriTemplate,
+        beaconChainExplorerUriTemplate:
+          chainDomain.beaconChainExplorerUriTemplate,
         disabledWallets: chainDomain.disabledWallets,
         features: chainDomain.features,
         gasPrice: chainDomain.gasPrice,

src/routes/chains/chains.service.ts

@@ -48,6 +48,7 @@ export class ChainsService {
         nativeCurrency: chain.nativeCurrency,
         transactionService: chain.transactionService,
         blockExplorerUriTemplate: chain.blockExplorerUriTemplate,
+        beaconChainExplorerUriTemplate: chain.beaconChainExplorerUriTemplate,
         disabledWallets: chain.disabledWallets,
         features: chain.features,
         gasPrice: chain.gasPrice,
@@ -82,6 +83,7 @@ export class ChainsService {
       nativeCurrency: result.nativeCurrency,
       transactionService: result.transactionService,
       blockExplorerUriTemplate: result.blockExplorerUriTemplate,
+      beaconChainExplorerUriTemplate: result.beaconChainExplorerUriTemplate,
       disabledWallets: result.disabledWallets,
       features: result.features,
       gasPrice: result.gasPrice,

src/routes/chains/entities/beacon-chain-explorer-uri-template.entity.ts

@@ -0,0 +1,9 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { BeaconChainExplorerUriTemplate as DomainBeaconChainExplorerUriTemplate } from '@/domain/chains/entities/beacon-chain-explorer-uri-template.entity';
+
+export class BeaconChainExplorerUriTemplate
+  implements DomainBeaconChainExplorerUriTemplate
+{
+  @ApiProperty({ type: String, nullable: true })
+  publicKey!: string | null;
+}

src/routes/chains/entities/chain.entity.ts

@@ -12,6 +12,10 @@ import {
   BlockExplorerUriTemplate,
   BlockExplorerUriTemplate as ApiBlockExplorerUriTemplate,
 } from '@/routes/chains/entities/block-explorer-uri-template.entity';
+import {
+  BeaconChainExplorerUriTemplate,
+  BeaconChainExplorerUriTemplate as ApiBeaconChainExplorerUriTemplate,
+} from '@/domain/chains/entities/beacon-chain-explorer-uri-template.entity';
 import {
   GasPriceOracle,
   GasPriceOracle as ApiGasPriceOracle,
@@ -56,6 +60,8 @@ export class Chain {
   @ApiProperty()
   blockExplorerUriTemplate: ApiBlockExplorerUriTemplate;
   @ApiProperty()
+  beaconChainExplorerUriTemplate: ApiBeaconChainExplorerUriTemplate;
+  @ApiProperty()
   disabledWallets: string[];
   @ApiPropertyOptional({ type: String, nullable: true })
   ensRegistryAddress: `0x${string}` | null;
@@ -97,6 +103,7 @@ export class Chain {
     nativeCurrency: NativeCurrency;
     transactionService: string;
     blockExplorerUriTemplate: BlockExplorerUriTemplate;
+    beaconChainExplorerUriTemplate: BeaconChainExplorerUriTemplate;
     disabledWallets: string[];
     features: string[];
     gasPrice: Array<GasPriceOracle | GasPriceFixed | GasPriceFixedEIP1559>;
@@ -120,6 +127,7 @@ export class Chain {
     this.nativeCurrency = args.nativeCurrency;
     this.transactionService = args.transactionService;
     this.blockExplorerUriTemplate = args.blockExplorerUriTemplate;
+    this.beaconChainExplorerUriTemplate = args.beaconChainExplorerUriTemplate;
     this.disabledWallets = args.disabledWallets;
     this.ensRegistryAddress = args.ensRegistryAddress;
     this.features = args.features;