Merge pull request #485 from rabbitholegg/matthew/boost-4268-implemen…

…t-getexternalurl-foundation

feat(foundation): implement `getExternalUrl` function

.changeset/fresh-buckets-float.md

@@ -0,0 +1,5 @@
+---
+"@rabbitholegg/questdk-plugin-foundation": minor
+---
+
+implement getExternalUrl function

packages/foundation/src/Foundation.test.ts

@@ -1,4 +1,4 @@
-import { mint } from './Foundation'
+import { getExternalUrl, mint } from './Foundation'
 // import { getFees, getMintIntent, simulateMint } from './Foundation'
 import {
   dutchAuctionResponse,
@@ -403,4 +403,37 @@ describe('Given the foundation plugin', () => {
       expect(request.value).toBe(value)
     })
   })
+
+  describe('getExternalUrl function', () => {
+    test('should return the correct url for a 721 mint', async () => {
+      const mint: MintActionParams = {
+        chainId: Chains.BASE,
+        contractAddress: '0xead6dca70b0465725a57eb81f7d3ab8b5e0b81b4',
+      }
+      const result = await getExternalUrl(mint)
+      expect(result).toBe(
+        'https://foundation.app/mint/base/0xead6dca70b0465725a57eb81f7d3ab8b5e0b81b4',
+      )
+    })
+
+    test('should return the base url for 1155 mint', async () => {
+      const mint: MintActionParams = {
+        chainId: Chains.BASE,
+        contractAddress: '0x1d2550d198197df1a10af515cf2ea0d790889b93',
+        tokenId: 213,
+      }
+      const result = await getExternalUrl(mint)
+      expect(result).toBe('https://foundation.app/')
+    })
+
+    test('should return the base url for unsupported chain', async () => {
+      const mint: MintActionParams = {
+        chainId: Chains.OPTIMISM,
+        contractAddress: '0x1d2550d198197df1a10af515cf2ea0d790889b93',
+        tokenId: 213,
+      }
+      const result = await getExternalUrl(mint)
+      expect(result).toBe('https://foundation.app/')
+    })
+  })
 })

packages/foundation/src/Foundation.ts

@@ -8,6 +8,7 @@ import {
   REFERRAL_ADDRESS,
 } from './constants'
 import {
+  CHAIN_TO_NETWORK_SLUG,
   calculateFees,
   getContractType,
   getDutchAuctionData,
@@ -341,6 +342,18 @@ export const simulateMint = async (
   throw new Error('Invalid contract type')
 }
 
+export const getExternalUrl = async (
+  params: MintActionParams,
+): Promise<string> => {
+  const { chainId, contractAddress, tokenId } = params
+  const baseUrl = 'https://foundation.app/'
+  const networkSlug = CHAIN_TO_NETWORK_SLUG[chainId]
+  if (tokenId != null || !networkSlug) {
+    return baseUrl
+  }
+  return `${baseUrl}mint/${networkSlug}/${contractAddress}`
+}
+
 export const getSupportedTokenAddresses = async (
   _chainId: number,
 ): Promise<Address[]> => {

packages/foundation/src/index.ts

@@ -5,6 +5,7 @@ import {
 } from '@rabbitholegg/questdk'
 
 import {
+  getExternalUrl,
   getFees,
   getMintIntent,
   getProjectFees,
@@ -16,6 +17,8 @@ import {
 
 export const Foundation: IActionPlugin = {
   pluginId: 'foundation',
+  getExternalUrl: async (params: ActionParams) =>
+    getExternalUrl(params as unknown as MintActionParams),
   getFees: async (params: ActionParams) =>
     getFees(params as unknown as MintActionParams),
   getMintIntent,

packages/foundation/src/utils.ts

@@ -8,11 +8,17 @@ import {
 } from './constants'
 import { type SaleTerms } from './types'
 import {
+  Chains,
   type MintActionParams,
   chainIdToViemChain,
 } from '@rabbitholegg/questdk-plugin-utils'
 import { type Address, type PublicClient, createPublicClient, http } from 'viem'
 
+export const CHAIN_TO_NETWORK_SLUG: Record<number, string | undefined> = {
+  [Chains.ETHEREUM]: 'eth',
+  [Chains.BASE]: 'base',
+}
+
 export async function getFixedPriceData(
   client: PublicClient,
   address: Address,