Skip to content

feat: Soften duplicate contract name in the case contracts have identical ABIs #4695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
silasdavis wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −3
Open

feat: Soften duplicate contract name in the case contracts have identical ABIs #4695

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions packages/cli/src/commands/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { watch } from 'chokidar'
import { default as dedent } from 'dedent'
import { basename, dirname, resolve } from 'pathe'
import pc from 'picocolors'
import { type Abi, type Address, getAddress } from 'viem'
import { type Abi, type Address, getAddress, keccak256 } from 'viem'
import { z } from 'zod'

import type { Contract, ContractConfig, Plugin, Watch } from '../config.js'
Expand Down Expand Up @@ -98,10 +98,19 @@ export async function generate(options: Generate = {}) {
const contractNames = new Set<string>()
const contractMap = new Map<string, Contract>()
for (const contractConfig of contractConfigs) {
if (contractNames.has(contractConfig.name))
const previouslySeenContract = contractMap.get(contractConfig.name)
if (previouslySeenContract) {
if (
hashAbi(previouslySeenContract.abi) === hashAbi(contractConfig.abi)
) {
// If the contract name and ABI match, skip adding it again, but allow it since this can occur when generating
// from sources that mutually import each other, such as peer Foundry projects.
continue
}
throw new Error(
`Contract name "${contractConfig.name}" must be unique.`,
`Duplicate contract name "${contractConfig.name}" found with different ABI. Contract names must be unique up to ABI.`,
)
}
const contract = await getContract({ ...contractConfig, isTypeScript })
contractMap.set(contract.name, contract)

Expand Down Expand Up @@ -407,3 +416,9 @@ function getBannerContent({ name }: { name: string }) {
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
`
}

function hashAbi(abi: Abi): string {
// Could use something faster, e.g. non-cryptographic hash or CRC32, but only called in the case
// we hit duplicate contract names, so probably not worth it.
return keccak256(Buffer.from(JSON.stringify(abi)))
}