Merge pull request #482 from rabbitholegg/matthew/boost-4266-implemen…

…t-getexternalurl-zora feat(zora): implement `getExternalUrl` function
rabbitholegg · Jul 16, 2024 · 0bf2cf6 · 0bf2cf6
2 parents 1f3dfb0 + ca73899
commit 0bf2cf6
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 2 deletions.
diff --git a/.changeset/hot-boats-help.md b/.changeset/hot-boats-help.md
@@ -0,0 +1,5 @@
+---
+"@rabbitholegg/questdk-plugin-zora": minor
+---
+
+implement getExternalUrl function
diff --git a/packages/zora/src/Zora.test.ts b/packages/zora/src/Zora.test.ts
@@ -1,6 +1,7 @@
 import {
   create,
   getDynamicNameParams,
+  getExternalUrl,
   getMintIntent,
   mint,
   simulateMint,
@@ -24,11 +25,12 @@ import {
   type PremintActionParams,
 } from '@rabbitholegg/questdk-plugin-utils'
 import { apply } from '@rabbitholegg/questdk'
-import { type Address, parseEther } from 'viem'
+import { type Address, getAddress, parseEther } from 'viem'
 import { describe, expect, test, vi, beforeEach, MockedFunction } from 'vitest'
 import { PremintResponse } from './types'
 import axios from 'axios'
 import { validatePremint } from './validate'
+import { ZORA_DEPLOYER_ADDRESS } from './contract-addresses'
 
 const MockedPremintResponse: PremintResponse = [
   {
@@ -513,3 +515,42 @@ describe('getDynamicNameParams function', () => {
     ).rejects.toThrow(`Invalid action type "${params.type}"`)
   })
 })
+
+describe('getExternalUrl function', () => {
+  test('should return correct url for 1155 mint with token id w/referral', async () => {
+    const params = {
+      chainId: Chains.ZORA,
+      contractAddress: getAddress('0x393c46fe7887697124a73f6028f39751aa1961a3'),
+      tokenId: 1,
+      referral: getAddress('0x1234567890123456789012345678901234567890'),
+    }
+    const result = await getExternalUrl(params)
+    expect(result).toBe(
+      'https://zora.co/collect/zora:0x393c46fe7887697124A73f6028f39751aA1961a3/1?referrer=0x1234567890123456789012345678901234567890',
+    )
+  })
+
+  test('should return correct url for 1155 mint with token id w/o referral', async () => {
+    const params = {
+      chainId: Chains.ZORA,
+      contractAddress: getAddress('0x393c46fe7887697124a73f6028f39751aa1961a3'),
+      tokenId: 1,
+    }
+    const result = await getExternalUrl(params)
+    expect(result).toBe(
+      `https://zora.co/collect/zora:0x393c46fe7887697124A73f6028f39751aA1961a3/1?referrer=${ZORA_DEPLOYER_ADDRESS}`,
+    )
+  })
+
+  test('should return correct url for 1155 mint without token id', async () => {
+    const params = {
+      chainId: Chains.ZORA,
+      contractAddress: getAddress('0x393c46fe7887697124a73f6028f39751aa1961a3'),
+      referral: getAddress('0x1234567890123456789012345678901234567890'),
+    }
+    const result = await getExternalUrl(params)
+    expect(result).toBe(
+      'https://zora.co/collect/zora:0x393c46fe7887697124A73f6028f39751aA1961a3?referrer=0x1234567890123456789012345678901234567890',
+    )
+  })
+})
diff --git a/packages/zora/src/Zora.ts b/packages/zora/src/Zora.ts
@@ -6,7 +6,7 @@ import {
   ZORA_MINTER_ABI_1155,
   ZORA_MINTER_ABI_1155_LEGACY,
 } from './abi'
-import { CHAIN_ID_ARRAY } from './chain-ids'
+import { CHAIN_ID_ARRAY, CHAIN_ID_TO_ZORA_SLUG } from './chain-ids'
 import {
   FIXED_PRICE_SALE_STRATS,
   ZORA_1155_FACTORY,
@@ -426,3 +426,16 @@ export const getDynamicNameParams = async (
   }
   return values
 }
+
+export const getExternalUrl = async (
+  params: MintActionParams,
+): Promise<string> => {
+  const { chainId, contractAddress, tokenId, referral } = params
+  const chainSlug = CHAIN_ID_TO_ZORA_SLUG[chainId]
+  const referralParams = `?referrer=${referral ?? ZORA_DEPLOYER_ADDRESS}`
+  const baseUrl = `https://zora.co/collect/${chainSlug}:${contractAddress}`
+
+  return tokenId != null
+    ? `${baseUrl}/${tokenId}${referralParams}`
+    : `${baseUrl}${referralParams}`
+}
diff --git a/packages/zora/src/chain-ids.ts b/packages/zora/src/chain-ids.ts
@@ -8,3 +8,12 @@ export const CHAIN_ID_ARRAY = [
   Chains.OPTIMISM,
   Chains.ZORA,
 ]
+
+export const CHAIN_ID_TO_ZORA_SLUG: Record<number, string> = {
+  [Chains.ARBITRUM_ONE]: 'arb',
+  [Chains.BASE]: 'base',
+  [Chains.BLAST]: 'blast',
+  [Chains.ETHEREUM]: 'eth',
+  [Chains.OPTIMISM]: 'oeth',
+  [Chains.ZORA]: 'zora',
+}
diff --git a/packages/zora/src/index.ts b/packages/zora/src/index.ts
@@ -8,6 +8,7 @@ import {
 import {
   create,
   getDynamicNameParams,
+  getExternalUrl,
   getFees,
   getMintIntent,
   getProjectFees,
@@ -28,6 +29,8 @@ export const Zora: IActionPlugin = {
   swap: async () => new PluginActionNotImplementedError(),
   mint,
   getDynamicNameParams,
+  getExternalUrl: async (params: ActionParams) =>
+    getExternalUrl(params as unknown as MintActionParams),
   getProjectFees: async (params: ActionParams) =>
     getProjectFees(params as unknown as MintActionParams),
   getFees: async (params: ActionParams) =>